Manage Application Advanced Settings

1. Create Advanced Settings for Application

This POST method configures advanced settings for an application.

Request Parameters

The request parameters used in this method are shown in the following table:

Request Example

curl --location -g --request POST '{{url}}/api/apps/{appId}/advanced-settings'
--header 'Authorization: TOKEN {{token}}'
{
  "settings": [
        {
            "settingsType": "ITSM",
            "connectionId": "71b94622-30ef-4d17-babb-94972ce4b2db",
            "connectionType": "servicenow",
            "isCommentRequired": false,
            "isITSMEnabled": true,
            "itsmFilterCriteria": [
                {
                    "supportedTicketType": "change_request",
                    "filter": {
                        "sysparm_query": ""
                    }
                }
            ]
        },
        {
       "settingsType" : "JUSTIFICATION",
       "isJustificationRequired" : true,
       "justificationRegex" : "XYZ"
     }
    ],
}

Response Example 

{
  "tenantId": "string",
  "consumer": "APP_PROFILE",
  "settings": [
        {
            "settingsType": "ITSM",
            "id": "4d1bae45-f80e-4f74-97af-083d44b10e21",
            "entityId": "brnlzt5tjzyc3ahmy9z2",
            "entityType": "APPLICATION",
            "isInherited": false,
            "connectionId": "71b94622-30ef-4d17-babb-94972ce4b2db",
            "connectionType": "servicenow",
            "isCommentRequired": false,
            "isITSMEnabled": true,
            "itsmFilterCriteria": [
                {
                    "supportedTicketType": "change_request",
                    "filter": {
                        "sysparm_query": ""
                    }
                }
            ]
        },
        {
       "settingsType" : "JUSTIFICATION",
       "id" : "4d1bae45-f80e-4f74-97af-083d44b10e21",
       "entityId" : "brnlzt5tjzyc3ahmy9z2",
       "entityType" : "APPLICATION",
       "isJustificationRequired" : true,
       "justificationRegex" : "XYZ"
     }
    ],
}

2. Get Advanced Settings for an Application

This GET method retrieves the advanced settings of an application specified by an appId.

Request Parameters

The request parameters used in this method are shown in the following table:

Request Example

curl --location -g --request GET '{{url}}/api/apps/{appId}/advanced-settings' 
--header 'Authorization: TOKEN {{token}}'

Response Example 

{
  "tenantId": "string",
  "consumer": "APP_PROFILE",
  "settings": [
        {
            "settingsType": "ITSM",
            "id": "4d1bae45-f80e-4f74-97af-083d44b10e21",
            "entityId": "brnlzt5tjzyc3ahmy9z2",
            "entityType": "APPLICATION",
            "isInherited": false,
            "connectionId": "71b94622-30ef-4d17-babb-94972ce4b2db",
            "connectionType": "servicenow",
            "isCommentRequired": false,
            "isITSMEnabled": true,
            "itsmFilterCriteria": [
                {
                    "supportedTicketType": "change_request",
                    "filter": {
                        "sysparm_query": ""
                    }
                }
            ]
        },
        {
       "settingsType" : "JUSTIFICATION",
       "id" : "4d1bae45-f80e-4f74-97af-083d44b10e21",
       "entityId" : "brnlzt5tjzyc3ahmy9z2",
       "entityType" : "APPLICATION",
       "isJustificationRequired" : true,
       "justificationRegex" : "XYZ"
     }
    ],
}

3. Update Advanced Settings for an Application

This PUT method updates the advanced settings of an application specified by appId.

Request Parameters

The request parameters used in this method are shown in the following table:

Request Example

curl --location -g --request PUT '{{url}}/api/apps/{appId}/advanced-settings' 
--header 'Authorization: TOKEN {{token}}'
{
 "settings": [
        {
            "settingsType": "ITSM",
            "connectionId": "71b94622-30ef-4d17-babb-94972ce4b2db",
            "connectionType": "servicenow",
            "isCommentRequired": false,
            "isITSMEnabled": true,
            "itsmFilterCriteria": [
                {
                    "supportedTicketType": "change_request",
                    "filter": {
                        "sysparm_query": ""
                    }
                }
            ]
        },
        {
       "settingsType" : "JUSTIFICATION",
       "isJustificationRequired" : true,
       "justificationRegex" : "XYZ"
     }
    ]
}

Response Example 

{
  "tenantId": "string",
  "consumer": "APP_PROFILE",
  "settings": [
        {
            "settingsType": "ITSM",
            "id": "4d1bae45-f80e-4f74-97af-083d44b10e21",
            "entityId": "brnlzt5tjzyc3ahmy9z2",
            "entityType": "APPLICATION",
            "isInherited": false,
            "connectionId": "71b94622-30ef-4d17-babb-94972ce4b2db",
            "connectionType": "servicenow",
            "isCommentRequired": false,
            "isITSMEnabled": true,
            "itsmFilterCriteria": [
                {
                    "supportedTicketType": "change_request",
                    "filter": {
                        "sysparm_query": ""
                    }
                }
            ]
        },
        {
       "settingsType" : "JUSTIFICATION",
       "id" : "4d1bae45-f80e-4f74-97af-083d44b10e21",
       "entityId" : "brnlzt5tjzyc3ahmy9z2",
       "entityType" : "APPLICATION",
       "isJustificationRequired" : true,
       "justificationRegex" : "XYZ"
     }
    ],
}

4. Delete Advanced Settings of an Application

This DELETE method deletes advanced settings of an application specified by appId.

Request Parameters

The request parameters used in this method are shown in the following table:

Request Example

curl --location -g --request DELETE '{{url}}/api/apps/{appId}/advanced-settings/{id}' 
--header 'Authorization: TOKEN {{token}}'

Response Example