• Aql
    • Icon
    • Import
    • Importsource
    • Iql
    • Object
    • Objectconnectedtickets
    • Objectschema
    • Objecttype
    • Objecttypeattribute
    • Operations
    • Progress
    • Config
    • Global
    Cloud
    Assets / Guides / REST API

    Objecttypeattribute

    Postman Collection
    OpenAPI
    POST

    Post objecttypeattribute {objectTypeId}

    Create a new attribute on the given object type

    Scopes
    write:cmdb-attribute:jira

    Request

    Path parameters

    objectTypeId

    string

    Required

    Request bodyapplication/json

    name

    string

    Required
    label

    boolean

    description

    string

    type

    integer

    Required
    defaultTypeId

    integer

    typeValue

    string

    typeValueMulti

    array<string>

    additionalValue

    string

    minimumCardinality

    integer

    maximumCardinality

    integer

    Responses

    application/json

    ObjectTypeAttribute

    The definition of the attribute that is associated with an object type

    POST/objecttypeattribute/{objectTypeId}
    1 2 3 4 5 6 7 8 9 10 curl --request POST \ --url 'https://api.atlassian.com/jsm/assets/workspace/{workspaceId}/v1/objecttypeattribute/{objectTypeId}' \ --header 'Authorization: Bearer <access_token>' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "name": "Geolocation", "type": "0", "defaultTypeId": "0" }'
    201Response
    1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 { "workspaceId": "g2778e1d-939d-581d-c8e2-9d5g59de456b", "globalId": "g2778e1d-939d-581d-c8e2-9d5g59de456b:1330", "id": "1330", "name": "Geolocation", "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": 6 }
    PUT

    Put objecttypeattribute {objectTypeId} {id}

    Update an existing object type attribute

    Scopes
    write:cmdb-attribute:jira

    Request

    Path parameters

    id

    string

    Required
    objectTypeId

    string

    Required

    Request bodyapplication/json

    name

    string

    label

    boolean

    description

    string

    type

    integer

    defaultTypeId

    integer

    typeValue

    string

    typeValueMulti

    array<string>

    additionalValue

    string

    minimumCardinality

    integer

    maximumCardinality

    integer

    Responses

    application/json

    ObjectTypeAttribute

    The definition of the attribute that is associated with an object type

    PUT/objecttypeattribute/{objectTypeId}/{id}
    1 2 3 4 5 6 7 8 curl --request PUT \ --url 'https://api.atlassian.com/jsm/assets/workspace/{workspaceId}/v1/objecttypeattribute/{objectTypeId}/{id}' \ --header 'Authorization: Bearer <access_token>' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "description": "GPS coordinates of the office" }'
    200Response
    1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 { "workspaceId": "g2778e1d-939d-581d-c8e2-9d5g59de456b", "globalId": "g2778e1d-939d-581d-c8e2-9d5g59de456b:1330", "id": "1330", "name": "Geolocation", "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": 6 }
    DEL

    Delete objecttypeattribute {id}

    Delete an existing object type attribute

    Scopes
    delete:cmdb-attribute:jira

    Request

    Path parameters

    id

    string

    Required

    Responses

    The object type attribute has been successfully deleted

    DEL/objecttypeattribute/{id}
    1 2 3 curl --request DELETE \ --url 'https://api.atlassian.com/jsm/assets/workspace/{workspaceId}/v1/objecttypeattribute/{id}' \ --header 'Authorization: Bearer <access_token>'