Aql
    Icon
    Import
    Importsource
    Iql
    Object
    Objectconnectedtickets
    Objectschema
    Objecttype
    Objecttypeattribute
    Progress
    Config
    Global

    Rate this page:

    Config

    Get config statustype

    GET /jsm/assets/workspace/{workspaceId}/v1/config/statustype

    Find all status

    Request

    Query parameters
    objectSchemaId

    string

    Include statuses for the object schema id. If supplied statuses for the object schema will be returned otherwise all global will be returned

    Example

    1
2
3
    curl --request GET \
  --url 'https://api.atlassian.com/jsm/assets/workspace/{workspaceId}/v1/config/statustype' \
  --header 'Accept: application/json'

    Responses

    Content typeValue
    application/json

    Array<Status>

    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
    [
  {
    "id": "1",
    "name": "Action Needed",
    "description": "",
    "category": 2,
    "objectSchemaId": null
  },
  {
    "id": "2",
    "name": "Active",
    "description": "",
    "category": 1,
    "objectSchemaId": null
  },
  {
    "id": "3",
    "name": "Closed",
    "description": "",
    "category": 0,
    "objectSchemaId": null
  },
  {
    "id": "4",
    "name": "In Service",
    "description": "",
    "category": 2,
    "objectSchemaId": null
  },
  {
    "id": "5",
    "name": "Running",
    "description": "",
    "category": 1,
    "objectSchemaId": null
  },
  {
    "id": "6",
    "name": "Stopped",
    "description": "",
    "category": 0,
    "objectSchemaId": null
  },
  {
    "id": "7",
    "name": "Support Requested",
    "description": "",
    "category": 2,
    "objectSchemaId": null
  }
]

    Post config statustype

    POST /jsm/assets/workspace/{workspaceId}/v1/config/statustype

    Create a new status

    Request

    Body parameters
    name Required

    string

    description

    string

    category Required

    integer

    NameValueColor
    ACTIVE1Green
    INACTIVE0Red
    PENDING2Yellow
    objectSchemaId

    string

    Example

    1
2
3
4
5
6
7
8
9
    curl --request POST \
  --url 'https://api.atlassian.com/jsm/assets/workspace/{workspaceId}/v1/config/statustype' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Decommissioned",
  "category": 0,
  "objectSchemaId": "6"
}'

    Responses

    Content typeValue
    application/json

    Status

    Example response (application/json)

    1
2
3
4
5
6
7
8
    {
  "workspaceId": "g2778e1d-939d-581d-c8e2-9d5g59de456b",
  "globalId": "g2778e1d-939d-581d-c8e2-9d5g59de456b:58",
  "id": "58",
  "name": "Decommissioned",
  "category": 0,
  "objectSchemaId": "6"
}

    Get config statustype {id}

    GET /jsm/assets/workspace/{workspaceId}/v1/config/statustype/{id}

    Find a status by id

    Request

    Path parameters
    id Required

    string

    Status type id

    Example

    1
2
3
    curl --request GET \
  --url 'https://api.atlassian.com/jsm/assets/workspace/{workspaceId}/v1/config/statustype/{id}' \
  --header 'Accept: application/json'

    Responses

    Content typeValue
    application/json

    Status

    Example response (application/json)

    1
2
3
4
5
6
7
8
    {
  "workspaceId": "g2778e1d-939d-581d-c8e2-9d5g59de456b",
  "globalId": "g2778e1d-939d-581d-c8e2-9d5g59de456b:58",
  "id": "58",
  "name": "Decommissioned",
  "category": 0,
  "objectSchemaId": "6"
}

    Put config statustype {id}

    PUT /jsm/assets/workspace/{workspaceId}/v1/config/statustype/{id}

    Update an existing status

    Request

    Path parameters
    id Required

    string

    Status type id

    Body parameters
    name Required

    string

    description

    string

    category Required

    integer

    NameValueColor
    ACTIVE1Green
    INACTIVE0Red
    PENDING2Yellow
    objectSchemaId

    string

    Example

    1
2
3
4
5
6
7
8
9
    curl --request PUT \
  --url 'https://api.atlassian.com/jsm/assets/workspace/{workspaceId}/v1/config/statustype/{id}' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Decommissioned",
  "category": 0,
  "objectSchemaId": "6"
}'

    Responses

    Content typeValue
    application/json

    Status

    Example response (application/json)

    1
2
3
4
5
6
7
8
    {
  "workspaceId": "g2778e1d-939d-581d-c8e2-9d5g59de456b",
  "globalId": "g2778e1d-939d-581d-c8e2-9d5g59de456b:58",
  "id": "58",
  "name": "Decommissioned",
  "category": 0,
  "objectSchemaId": "6"
}

    Delete config statustype {id}

    DELETE /jsm/assets/workspace/{workspaceId}/v1/config/statustype/{id}

    Delete an existing status

    Request

    Path parameters
    id Required

    string

    Status type id

    Example

    1
2
    curl --request DELETE \
  --url 'https://api.atlassian.com/jsm/assets/workspace/{workspaceId}/v1/config/statustype/{id}'

    Responses

    The status has been successfully deleted

    A schema has not been defined for this response code.

    Rate this page: