Icon
    Import
    Iql
    Object
    Objectconnectedtickets
    Objectschema
    Objecttype
    Objecttypeattribute
    Progress
    Config

    Rate this page:

    Objectschema

    Get objectschema list

    GET /jsm/insight/workspace/{workspaceId}/v{version}/objectschema/list

    Resource to find object schemas in Insight

    Request

    There are no parameters for this request.

    Example

    1
    2
    3
    curl --request GET \
      --url 'https://api.atlassian.com/jsm/insight/workspace/{workspaceId}/v{version}/objectschema/list' \
      --header 'Accept: application/json'

    Responses

    Content typeValue
    application/json

    ObjectSchemaList

    Example response (application/json)

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    {
      "startAt": 0,
      "maxResults": 25,
      "total": 5,
      "values": [
        {
          "workspaceId": "g2778e1d-939d-581d-c8e2-9d5g59de456b",
          "globalId": "g2778e1d-939d-581d-c8e2-9d5g59de456b:13",
          "id": "13",
          "name": "Discovery import",
          "objectSchemaKey": "NS",
          "status": "Ok",
          "description": "",
          "created": "2021-02-22T02:31:31.748Z",
          "updated": "2021-03-26T12:12:46.132Z",
          "objectCount": 231,
          "objectTypeCount": 23,
          "idAsInt": 13
        },
        {
          "workspaceId": "g2778e1d-939d-581d-c8e2-9d5g59de456b",
          "globalId": "g2778e1d-939d-581d-c8e2-9d5g59de456b:6",
          "id": "6",
          "name": "ITSM",
          "objectSchemaKey": "ITSM",
          "status": "Ok",
          "created": "2021-02-16T18:04:31.284Z",
          "updated": "2021-02-16T18:04:31.288Z",
          "objectCount": 95,
          "objectTypeCount": 34,
          "idAsInt": 6
        },
        {
          "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a",
          "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:1",
          "id": "1",
          "name": "Human Resources",
          "objectSchemaKey": "HR",
          "status": "Ok",
          "created": "2021-02-15T22:05:30.709Z",
          "updated": "2021-03-18T13:49:57.909Z",
          "objectCount": 1023,
          "objectTypeCount": 14,
          "idAsInt": 1
        },
        {
          "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a",
          "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:27",
          "id": "27",
          "name": "Services",
          "objectSchemaKey": "SVC",
          "status": "Ok",
          "description": "Contains the 'Service' object type and services your site uses across projects.",
          "created": "2021-03-19T04:52:40.418Z",
          "updated": "2021-03-19T04:52:40.428Z",
          "objectCount": 37,
          "objectTypeCount": 1,
          "idAsInt": 27
        },
        {
          "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a",
          "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:30",
          "id": "30",
          "name": "Word life",
          "objectSchemaKey": "WL",
          "status": "Ok",
          "created": "2021-03-28T23:19:49.290Z",
          "updated": "2021-03-28T23:19:49.299Z",
          "objectCount": 0,
          "objectTypeCount": 0,
          "idAsInt": 30
        }
      ],
      "isLast": true
    }

    Post objectschema create

    POST /jsm/insight/workspace/{workspaceId}/v{version}/objectschema/create

    Create a new object schema

    Request

    Body parameters

    Used to update and create object schema

    name Required

    string

    objectSchemaKey Required

    string

    description

    string

    Example

    1
    2
    3
    4
    5
    6
    7
    8
    9
    curl --request POST \
      --url 'https://api.atlassian.com/jsm/insight/workspace/{workspaceId}/v{version}/objectschema/create' \
      --header 'Accept: application/json' \
      --header 'Content-Type: application/json' \
      --data '{
      "name": "Computers",
      "objectSchemaKey": "COMP",
      "description": "The IT department schema"
    }'

    Responses

    Content typeValue
    application/json

    ObjectSchema

    Example response (application/json)

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    {
      "workspaceId": "g2778e1d-939d-581d-c8e2-9d5g59de456b",
      "globalId": "g2778e1d-939d-581d-c8e2-9d5g59de456b:39",
      "id": "39",
      "name": "Computers",
      "objectSchemaKey": "COMP",
      "status": "Ok",
      "description": "The IT department schema",
      "created": "2021-04-20T16:21:18.908Z",
      "updated": "2021-04-20T16:21:18.912Z",
      "objectCount": 0,
      "objectTypeCount": 0,
      "idAsInt": 39
    }

    Get objectschema {id}

    GET /jsm/insight/workspace/{workspaceId}/v{version}/objectschema/{id}

    Find a schema by id

    Request

    Path parameters
    id Required

    string

    The object schema id

    Example

    1
    2
    3
    curl --request GET \
      --url 'https://api.atlassian.com/jsm/insight/workspace/{workspaceId}/v{version}/objectschema/{id}' \
      --header 'Accept: application/json'

    Responses

    Content typeValue
    application/json

    ObjectSchema

    Example response (application/json)

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    {
      "workspaceId": "g2778e1d-939d-581d-c8e2-9d5g59de456b",
      "globalId": "g2778e1d-939d-581d-c8e2-9d5g59de456b:39",
      "id": "39",
      "name": "Computers",
      "objectSchemaKey": "COMP",
      "status": "Ok",
      "description": "The IT department schema",
      "created": "2021-04-20T16:21:18.908Z",
      "updated": "2021-04-20T16:21:18.912Z",
      "objectCount": 0,
      "objectTypeCount": 0,
      "idAsInt": 39
    }

    Put objectschema {id}

    PUT /jsm/insight/workspace/{workspaceId}/v{version}/objectschema/{id}

    Update an object schema

    Request

    Path parameters
    id Required

    string

    The object schema id

    Body parameters

    Used to update and create object schema

    name Required

    string

    objectSchemaKey Required

    string

    description

    string

    Example

    1
    2
    3
    4
    5
    6
    7
    8
    9
    curl --request PUT \
      --url 'https://api.atlassian.com/jsm/insight/workspace/{workspaceId}/v{version}/objectschema/{id}' \
      --header 'Accept: application/json' \
      --header 'Content-Type: application/json' \
      --data '{
      "name": "Computers",
      "objectSchemaKey": "COMP",
      "description": "The IT department schema"
    }'

    Responses

    Content typeValue
    application/json

    ObjectSchema

    Example response (application/json)

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    {
      "workspaceId": "g2778e1d-939d-581d-c8e2-9d5g59de456b",
      "globalId": "g2778e1d-939d-581d-c8e2-9d5g59de456b:39",
      "id": "39",
      "name": "Computers",
      "objectSchemaKey": "COMP",
      "status": "Ok",
      "description": "The IT department schema",
      "created": "2021-04-20T16:21:18.908Z",
      "updated": "2021-04-20T16:21:18.912Z",
      "objectCount": 0,
      "objectTypeCount": 0,
      "idAsInt": 39
    }

    Delete objectschema {id}

    DELETE /jsm/insight/workspace/{workspaceId}/v{version}/objectschema/{id}

    Delete a schema

    Request

    Path parameters
    id Required

    string

    The object schema id

    Example

    1
    2
    3
    curl --request DELETE \
      --url 'https://api.atlassian.com/jsm/insight/workspace/{workspaceId}/v{version}/objectschema/{id}' \
      --header 'Accept: application/json'

    Responses

    Content typeValue
    application/json

    ObjectSchema

    Example response (application/json)

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    {
      "workspaceId": "g2778e1d-939d-581d-c8e2-9d5g59de456b",
      "globalId": "g2778e1d-939d-581d-c8e2-9d5g59de456b:39",
      "id": "39",
      "name": "Computers",
      "objectSchemaKey": "COMP",
      "status": "Ok",
      "description": "The IT department schema",
      "created": "2021-04-20T16:21:18.908Z",
      "updated": "2021-04-20T16:21:18.912Z",
      "objectCount": 0,
      "objectTypeCount": 0,
      "idAsInt": 39
    }

    Get objectschema {id} attributes

    GET /jsm/insight/workspace/{workspaceId}/v{version}/objectschema/{id}/attributes

    Find all object type attributes for this object schema

    Request

    Path parameters
    id Required

    string

    The object schema id

    Query parameters
    onlyValueEditable

    boolean

    Return only values that are associated with values that can be edited

    Default: false
    extended

    boolean

    Include the object type with each object type attribute

    Default: false
    query

    string

    A query that will be used to filter object type attributes by their name

    Default: ""

    Example

    1
    2
    3
    curl --request GET \
      --url 'https://api.atlassian.com/jsm/insight/workspace/{workspaceId}/v{version}/objectschema/{id}/attributes' \
      --header 'Accept: application/json'

    Responses

    Content typeValue
    application/json

    Array<ObjectTypeAttribute>

    Example response (application/json)

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86
    87
    88
    89
    90
    91
    92
    93
    94
    95
    96
    97
    98
    99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    184
    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211
    212
    213
    214
    215
    216
    217
    218
    219
    220
    221
    222
    223
    224
    225
    226
    227
    228
    229
    230
    231
    232
    233
    234
    235
    236
    237
    238
    239
    240
    241
    242
    243
    244
    245
    246
    247
    [
      {
        "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a",
        "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:868",
        "id": "868",
        "name": "Tier",
        "label": false,
        "defaultType": {
          "id": 10,
          "name": "Select"
        },
        "editable": true,
        "system": false,
        "sortable": true,
        "summable": false,
        "indexed": true,
        "minimumCardinality": 1,
        "maximumCardinality": 1,
        "removable": true,
        "hidden": false,
        "includeChildObjectTypes": false,
        "uniqueAttribute": false,
        "options": "Tier 1,Tier 2,Tier 3,Tier 4",
        "position": 5
      },
      {
        "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a",
        "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:867",
        "id": "867",
        "name": "Description",
        "label": false,
        "defaultType": {
          "id": 0,
          "name": "Text"
        },
        "editable": true,
        "system": false,
        "sortable": true,
        "summable": false,
        "indexed": true,
        "minimumCardinality": 0,
        "maximumCardinality": 1,
        "removable": true,
        "hidden": false,
        "includeChildObjectTypes": false,
        "uniqueAttribute": false,
        "options": "",
        "position": 4
      },
      {
        "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a",
        "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:869",
        "id": "869",
        "name": "Service relationships",
        "label": false,
        "referenceType": {
          "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a",
          "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:36",
          "id": "36",
          "name": "Depends on",
          "color": "42526E",
          "url16": "https://api.atlassian.com/jsm/insight/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/config/referencetype/36/image.png?size=16",
          "removable": false,
          "objectSchemaId": "27"
        },
        "referenceObjectTypeId": "122",
        "referenceObjectType": {
          "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a",
          "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:122",
          "id": "122",
          "name": "Service",
          "type": 0,
          "description": "This object type contains the services your site uses across projects.",
          "icon": {
            "id": "164",
            "name": "Service",
            "url16": "https://api.atlassian.com/jsm/insight/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/122/icon.png?size=16",
            "url48": "https://api.atlassian.com/jsm/insight/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/122/icon.png?size=48"
          },
          "position": 0,
          "created": "2021-03-19T04:52:40.472Z",
          "updated": "2021-03-19T04:52:40.472Z",
          "objectCount": 0,
          "objectSchemaId": "27",
          "inherited": false,
          "abstractObjectType": false,
          "parentObjectTypeInherited": false
        },
        "editable": true,
        "system": false,
        "sortable": true,
        "summable": false,
        "indexed": true,
        "minimumCardinality": 0,
        "maximumCardinality": -1,
        "removable": true,
        "hidden": false,
        "includeChildObjectTypes": false,
        "uniqueAttribute": false,
        "options": "",
        "position": 6
      },
      {
        "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a",
        "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:866",
        "id": "866",
        "name": "Updated",
        "label": false,
        "defaultType": {
          "id": 6,
          "name": "DateTime"
        },
        "editable": false,
        "system": true,
        "sortable": true,
        "summable": false,
        "indexed": true,
        "minimumCardinality": 0,
        "maximumCardinality": 1,
        "removable": true,
        "hidden": false,
        "includeChildObjectTypes": false,
        "uniqueAttribute": false,
        "options": "",
        "position": 3
      },
      {
        "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a",
        "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:865",
        "id": "865",
        "name": "Created",
        "label": false,
        "defaultType": {
          "id": 6,
          "name": "DateTime"
        },
        "editable": false,
        "system": true,
        "sortable": true,
        "summable": false,
        "indexed": true,
        "minimumCardinality": 1,
        "maximumCardinality": 1,
        "removable": true,
        "hidden": false,
        "includeChildObjectTypes": false,
        "uniqueAttribute": false,
        "options": "",
        "position": 2
      },
      {
        "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a",
        "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:863",
        "id": "863",
        "name": "Key",
        "label": false,
        "defaultType": {
          "id": 0,
          "name": "Text"
        },
        "editable": false,
        "system": true,
        "sortable": true,
        "summable": false,
        "indexed": true,
        "minimumCardinality": 1,
        "maximumCardinality": 1,
        "removable": true,
        "hidden": false,
        "includeChildObjectTypes": false,
        "uniqueAttribute": false,
        "options": "",
        "position": 0
      },
      {
        "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a",
        "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:870",
        "id": "870",
        "name": "Service ID",
        "label": false,
        "defaultType": {
          "id": 0,
          "name": "Text"
        },
        "editable": true,
        "system": false,
        "sortable": true,
        "summable": false,
        "indexed": true,
        "minimumCardinality": 1,
        "maximumCardinality": 1,
        "removable": true,
        "hidden": false,
        "includeChildObjectTypes": false,
        "uniqueAttribute": true,
        "options": "",
        "position": 7
      },
      {
        "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a",
        "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:864",
        "id": "864",
        "name": "Name",
        "label": true,
        "defaultType": {
          "id": 0,
          "name": "Text"
        },
        "editable": true,
        "system": false,
        "sortable": true,
        "summable": false,
        "indexed": true,
        "minimumCardinality": 1,
        "maximumCardinality": 1,
        "removable": false,
        "hidden": false,
        "includeChildObjectTypes": false,
        "uniqueAttribute": false,
        "options": "",
        "position": 1
      },
      {
        "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a",
        "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:871",
        "id": "871",
        "name": "Revision",
        "label": false,
        "defaultType": {
          "id": 0,
          "name": "Text"
        },
        "editable": true,
        "system": false,
        "sortable": true,
        "summable": false,
        "indexed": true,
        "minimumCardinality": 1,
        "maximumCardinality": 1,
        "removable": true,
        "hidden": true,
        "includeChildObjectTypes": false,
        "uniqueAttribute": false,
        "options": "",
        "position": 8
      }
    ]

    Get objectschema {id} objecttypes flat

    GET /jsm/insight/workspace/{workspaceId}/v{version}/objectschema/{id}/objecttypes/flat

    Find all object types for this object schema

    Request

    Path parameters
    id Required

    string

    The object schema id

    Query parameters
    includeObjectCounts

    boolean

    If true, the objectCount attribute is populated for each object type

    Default: false

    Example

    1
    2
    3
    curl --request GET \
      --url 'https://api.atlassian.com/jsm/insight/workspace/{workspaceId}/v{version}/objectschema/{id}/objecttypes/flat' \
      --header 'Accept: application/json'

    Responses

    Content typeValue
    application/json

    Array<ObjectType>

    Example response (application/json)

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    [
      {
        "workspaceId": "g2778e1d-939d-581d-c8e2-9d5g59de456b",
        "globalId": "g2778e1d-939d-581d-c8e2-9d5g59de456b:19",
        "id": "19",
        "name": "Employee",
        "icon": {
          "id": "131",
          "name": "Users",
          "url16": "https://api.atlassian.com/jsm/insight/workspace/g2778e1d-939d-581d-c8e2-9d5g59de456b/v1/objecttype/19/icon.png?size=16",
          "url48": "https://api.atlassian.com/jsm/insight/workspace/g2778e1d-939d-581d-c8e2-9d5g59de456b/v1/objecttype/19/icon.png?size=48"
        },
        "position": 0,
        "created": "2021-02-16T18:32:38.173Z",
        "updated": "2021-02-16T19:37:07.179Z",
        "objectCount": 0,
        "objectSchemaId": "6",
        "inherited": false,
        "abstractObjectType": false,
        "parentObjectTypeInherited": false
      },
      {
        "workspaceId": "g2778e1d-939d-581d-c8e2-9d5g59de456b",
        "globalId": "g2778e1d-939d-581d-c8e2-9d5g59de456b:23",
        "id": "23",
        "name": "Office",
        "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin nec ex.",
        "icon": {
          "id": "13",
          "name": "Building",
          "url16": "https://api.atlassian.com/jsm/insight/workspace/g2778e1d-939d-581d-c8e2-9d5g59de456b/v1/objecttype/23/icon.png?size=16",
          "url48": "https://api.atlassian.com/jsm/insight/workspace/g2778e1d-939d-581d-c8e2-9d5g59de456b/v1/objecttype/23/icon.png?size=48"
        },
        "position": 2,
        "created": "2021-02-16T19:36:51.951Z",
        "updated": "2021-04-16T15:17:03.384Z",
        "objectCount": 0,
        "objectSchemaId": "6",
        "inherited": false,
        "abstractObjectType": false,
        "parentObjectTypeInherited": false
      },
      {
        "workspaceId": "g2778e1d-939d-581d-c8e2-9d5g59de456b",
        "globalId": "g2778e1d-939d-581d-c8e2-9d5g59de456b:24",
        "id": "24",
        "name": "City",
        "icon": {
          "id": "28",
          "name": "Cottage",
          "url16": "https://api.atlassian.com/jsm/insight/workspace/g2778e1d-939d-581d-c8e2-9d5g59de456b/v1/objecttype/24/icon.png?size=16",
          "url48": "https://api.atlassian.com/jsm/insight/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/24/icon.png?size=48"
        },
        "position": 3,
        "created": "2021-02-16T19:58:45.698Z",
        "updated": "2021-04-16T15:17:03.393Z",
        "objectCount": 0,
        "objectSchemaId": "6",
        "inherited": false,
        "abstractObjectType": false,
        "parentObjectTypeInherited": false
      }
    ]

    Rate this page: