Schemas

The Schemas API provides endpoints to create, read, update, and manage schemas used within your system. The configuration incorporates filters, pagination and sorting.

Get list of schemas

GEThttps://app.configure8.io/public/v1/schemas

Query parameters

Response

200400401403500

Body

application/json

items*array of SchemaDto (object)

total*number

pageNumber*number

Requested page, note that it starts with 0

pageSize*number

Maximum scorecards in one paginated response

Request

JavaScriptCurlPython

const response = await fetch('https://app.configure8.io/public/v1/schemas', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "items": [
    {
      "id": "text",
      "orgId": "text",
      "name": "text",
      "description": "text",
      "type": "application",
      "subType": "text",
      "identifier": "text",
      "icon": "text",
      "properties": [
        {
          "name": "text",
          "columnName": "text",
          "hidden": false,
          "views": [
            "text"
          ]
        }
      ],
      "relations": [
        {
          "id": "text",
          "name": "text",
          "columnName": "text",
          "foreignerName": "text",
          "foreignerColumnName": "text",
          "type": "application",
          "subType": "text",
          "relationType": "one_to_one"
        }
      ],
      "tabs": [
        {
          "name": "text",
          "description": "text",
          "type": "LEGACY",
          "identifier": "text",
          "widgets": [
            {
              "schemaWidgetId": "text",
              "title": "text",
              "width": 0,
              "row": 0,
              "column": 0,
              "description": "text",
              "height": 0,
              "showTitle": false,
              "showBorder": false,
              "configuration": "text"
            }
          ],
          "sort": 0,
          "schemaRelation": "text"
        }
      ],
      "createdBy": "text",
      "user": {
        "displayName": "text",
        "photoUrl": "text"
      },
      "lastChangedBy": "text",
      "createdAt": "2024-11-23T11:10:24.324Z",
      "updatedAt": "2024-11-23T11:10:24.324Z",
      "order": 0,
      "displayActionsColumn": false,
      "treeView": {
        "enabled": false,
        "relation": "text",
        "pathProperty": "text"
      }
    }
  ],
  "total": 0,
  "pageNumber": 0,
  "pageSize": 0
}

Create a new schema

POSThttps://app.configure8.io/public/v1/schemas

Body

application/json

Schema object to be created.

name*string

descriptionstring

The description of schema

type*enum

applicationserviceresourceenvironmentpersonrepositorylibrarymanifestteambaserangecostscorecardscorecard_metricscorecard_metric_resultsownervulnerabilityaws_security_hub_finding

subTypenullable string

identifier*string

icon*one of

stringobjectobject

jsonSchemaValidatorobject

propertiesarray of SchemaPropertyObjectDto (object)

relationsnullable array of SchemaRelationDto (object)

tabs*nullable array of TabDto (object)

treeViewobject

Tree view display settings

Response

201400401403500

Body

application/json

id*string

orgId*string

name*string

descriptionstring

Schema entity description

type*enum

applicationserviceresourceenvironmentpersonrepositorylibrarymanifestteambaserangecostscorecardscorecard_metricscorecard_metric_resultsownervulnerabilityaws_security_hub_finding

subTypenullable string

identifier*string

icon*one of

stringobjectobject

propertiesarray of SchemaPropertyObjectDto (object)

jsonSchemaValidatorobject

A JSON schema validator object

relationsnullable array of SchemaRelationDto (object)

tabs*nullable array of TabDto (object)

createdBy*string

userobject

lastChangedBy*string

createdAt*string (date-time)

updatedAtstring (date-time)

order*number

displayActionsColumnnullable boolean

treeViewnullable object

Request

JavaScriptCurlPython

const response = await fetch('https://app.configure8.io/public/v1/schemas', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "type": "application",
      "identifier": "text",
      "icon": "text",
      "tabs": [
        {
          "name": "text",
          "type": "LEGACY",
          "identifier": "text",
          "widgets": [
            {
              "title": "text",
              "width": 0,
              "row": 0,
              "column": 0
            }
          ],
          "sort": 0
        }
      ]
    }),
});
const data = await response.json();

Response

201

{
  "id": "text",
  "orgId": "text",
  "name": "text",
  "description": "text",
  "type": "application",
  "subType": "text",
  "identifier": "text",
  "icon": "text",
  "properties": [
    {
      "name": "text",
      "columnName": "text",
      "hidden": false,
      "views": [
        "text"
      ]
    }
  ],
  "relations": [
    {
      "id": "text",
      "name": "text",
      "columnName": "text",
      "foreignerName": "text",
      "foreignerColumnName": "text",
      "type": "application",
      "subType": "text",
      "relationType": "one_to_one"
    }
  ],
  "tabs": [
    {
      "name": "text",
      "description": "text",
      "type": "LEGACY",
      "identifier": "text",
      "widgets": [
        {
          "schemaWidgetId": "text",
          "title": "text",
          "width": 0,
          "row": 0,
          "column": 0,
          "description": "text",
          "height": 0,
          "showTitle": false,
          "showBorder": false,
          "configuration": "text"
        }
      ],
      "sort": 0,
      "schemaRelation": "text"
    }
  ],
  "createdBy": "text",
  "user": {
    "displayName": "text",
    "photoUrl": "text"
  },
  "lastChangedBy": "text",
  "createdAt": "2024-11-23T11:10:24.324Z",
  "updatedAt": "2024-11-23T11:10:24.324Z",
  "order": 0,
  "displayActionsColumn": false,
  "treeView": {
    "enabled": false,
    "relation": "text",
    "pathProperty": "text"
  }
}

Update a schema entity

PUThttps://app.configure8.io/public/v1/schemas/{id}

Path parameters

id*string

ID of the schema entity.

Body

application/json

Schema object to be updated.

name*string

descriptionstring

The description of schema

identifier*string

icon*object

jsonSchemaValidatorobject

propertiesarray of SchemaPropertyObjectDto (object)

relationsnullable array of SchemaRelationDto (object)

tabs*nullable array of TabDto (object)

treeViewobject

Tree view display settings

Response

200400401403404500

Body

application/json

id*string

orgId*string

name*string

descriptionstring

Schema entity description

type*enum

applicationserviceresourceenvironmentpersonrepositorylibrarymanifestteambaserangecostscorecardscorecard_metricscorecard_metric_resultsownervulnerabilityaws_security_hub_finding

subTypenullable string

identifier*string

icon*one of

stringobjectobject

propertiesarray of SchemaPropertyObjectDto (object)

jsonSchemaValidatorobject

A JSON schema validator object

relationsnullable array of SchemaRelationDto (object)

tabs*nullable array of TabDto (object)

createdBy*string

userobject

lastChangedBy*string

createdAt*string (date-time)

updatedAtstring (date-time)

order*number

displayActionsColumnnullable boolean

treeViewnullable object

Request

JavaScriptCurlPython

const response = await fetch('https://app.configure8.io/public/v1/schemas/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "identifier": "text",
      "tabs": [
        {
          "name": "text",
          "type": "LEGACY",
          "identifier": "text",
          "widgets": [
            {
              "title": "text",
              "width": 0,
              "row": 0,
              "column": 0
            }
          ],
          "sort": 0
        }
      ]
    }),
});
const data = await response.json();

Response

200

{
  "id": "text",
  "orgId": "text",
  "name": "text",
  "description": "text",
  "type": "application",
  "subType": "text",
  "identifier": "text",
  "icon": "text",
  "properties": [
    {
      "name": "text",
      "columnName": "text",
      "hidden": false,
      "views": [
        "text"
      ]
    }
  ],
  "relations": [
    {
      "id": "text",
      "name": "text",
      "columnName": "text",
      "foreignerName": "text",
      "foreignerColumnName": "text",
      "type": "application",
      "subType": "text",
      "relationType": "one_to_one"
    }
  ],
  "tabs": [
    {
      "name": "text",
      "description": "text",
      "type": "LEGACY",
      "identifier": "text",
      "widgets": [
        {
          "schemaWidgetId": "text",
          "title": "text",
          "width": 0,
          "row": 0,
          "column": 0,
          "description": "text",
          "height": 0,
          "showTitle": false,
          "showBorder": false,
          "configuration": "text"
        }
      ],
      "sort": 0,
      "schemaRelation": "text"
    }
  ],
  "createdBy": "text",
  "user": {
    "displayName": "text",
    "photoUrl": "text"
  },
  "lastChangedBy": "text",
  "createdAt": "2024-11-23T11:10:24.324Z",
  "updatedAt": "2024-11-23T11:10:24.324Z",
  "order": 0,
  "displayActionsColumn": false,
  "treeView": {
    "enabled": false,
    "relation": "text",
    "pathProperty": "text"
  }
}

Get a schema entity

GEThttps://app.configure8.io/public/v1/schemas/{id}

Path parameters

id*string

ID of the schema entity.

Response

200400401403404500

Body

application/json

id*string

orgId*string

name*string

descriptionstring

Schema entity description

type*enum

applicationserviceresourceenvironmentpersonrepositorylibrarymanifestteambaserangecostscorecardscorecard_metricscorecard_metric_resultsownervulnerabilityaws_security_hub_finding

subTypenullable string

identifier*string

icon*one of

stringobjectobject

propertiesarray of SchemaPropertyObjectDto (object)

jsonSchemaValidatorobject

A JSON schema validator object

relationsnullable array of SchemaRelationDto (object)

tabs*nullable array of TabDto (object)

createdBy*string

userobject

lastChangedBy*string

createdAt*string (date-time)

updatedAtstring (date-time)

order*number

displayActionsColumnnullable boolean

treeViewnullable object

Request

JavaScriptCurlPython

const response = await fetch('https://app.configure8.io/public/v1/schemas/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "id": "text",
  "orgId": "text",
  "name": "text",
  "description": "text",
  "type": "application",
  "subType": "text",
  "identifier": "text",
  "icon": "text",
  "properties": [
    {
      "name": "text",
      "columnName": "text",
      "hidden": false,
      "views": [
        "text"
      ]
    }
  ],
  "relations": [
    {
      "id": "text",
      "name": "text",
      "columnName": "text",
      "foreignerName": "text",
      "foreignerColumnName": "text",
      "type": "application",
      "subType": "text",
      "relationType": "one_to_one"
    }
  ],
  "tabs": [
    {
      "name": "text",
      "description": "text",
      "type": "LEGACY",
      "identifier": "text",
      "widgets": [
        {
          "schemaWidgetId": "text",
          "title": "text",
          "width": 0,
          "row": 0,
          "column": 0,
          "description": "text",
          "height": 0,
          "showTitle": false,
          "showBorder": false,
          "configuration": "text"
        }
      ],
      "sort": 0,
      "schemaRelation": "text"
    }
  ],
  "createdBy": "text",
  "user": {
    "displayName": "text",
    "photoUrl": "text"
  },
  "lastChangedBy": "text",
  "createdAt": "2024-11-23T11:10:24.324Z",
  "updatedAt": "2024-11-23T11:10:24.324Z",
  "order": 0,
  "displayActionsColumn": false,
  "treeView": {
    "enabled": false,
    "relation": "text",
    "pathProperty": "text"
  }
}

Delete a schema entity

DELETEhttps://app.configure8.io/public/v1/schemas/{id}

Path parameters

id*string

ID of the schema entity.

Response

204400401403404500

Schema deleted

Request

JavaScriptCurlPython

const response = await fetch('https://app.configure8.io/public/v1/schemas/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();