1. Get Access Profile Settings for the given Profile ID
This GET method retrieves the access profile settings for an application profile.
GET | {{url}}/api/access/{profileId}/environments/{environmentId}/settings |
Request Parameters
The request parameters used in this method are shown in the following table:
Parameter | Description | Data Type | Required |
profileId | Profile ID to get Profile Access Setting | String | Mandatory |
environmentId | Environment ID to get Profile Access Setting | String | Mandatory |
Request Example
curl --location -g --request GET '{{url}}/api/access/{profileId}/environments/{environmentId}/settings'
--header 'Authorization: TOKEN {{token}}'
Response Example
Status: 200 OK |
{
"profileId" : "ye769to37hhez3irminr",
"environmentId" : "881409387174",
"justificationSetting" : {
"settingsType" : "JUSTIFICATION",
"isJustificationRequiredAtCheckout" : true,
"justificationRegex": "[a-zA-Z]+"
},
"itsmSetting" : {
"settingsType" : "ITSM",
"connectionType" : "jira",
"isITSMEnabled" : true,
"supportedTicketTypes" : [ "issue" ]
},
"approvalRequestData": {
"justification": "Test",
"ticketId": "Test-1",
"ticketType": "issue"
}
}
2. Search Tickets
This GET method retrieves the tickets matching the search text and the ITSM integration setting available for the profile.
GET | {{url}}/api/access/{profileId}/environments/{environmentId}/itsm/{ticketType}/search |
Request Parameters
The request parameters used in this method are shown in the following table:
Parameter | Description | Data Type | Required |
profileId | Profile ID to get Profile Access Setting | String | Mandatory |
environmentId | Environment ID to get Profile Access Setting | String | Mandatory |
ticketType | Ticket type for ITSM ticket searching | String | Mandatory |
searchText | Text for searching | String | Optional |
Request Example
curl --location -g --request GET '{{url}}/api/access/{profileId}/environments/{environmentId}/itsm/{ticketType}/search'
--header 'Authorization: TOKEN {{token}}'
Response Example
Status: 200 OK |
{
"totalCount": 0,
"maxResults": 0,
"tickets": {}
}
3. Validate ITSM Ticket
This GET method validates the ITSM ticket using the ITSM integration setting available for the profile.
GET | {{url}}/api/access/{profileId}/environments/{environmentId}/itsm/{ticketType}/validate/{ticketId} |
Request Parameters
The request parameters used in this method are shown in the following table:
Parameter | Description | Data Type | Required |
profileId | Profile ID to get Profile Access Setting | String | Mandatory |
environmentId | Environment ID to get Profile Access Setting | String | Mandatory |
ticketType | Ticket type for ITSM ticket searching | String | Mandatory |
ticketId | Ticket Id for the validation | String | Mandatory |
Request Example
curl --location -g --request GET '{{url}}/api/access/{profileId}/environments/{environmentId}/itsm/{ticketType}/validate/{ticketId}'
--header 'Authorization: TOKEN {{token}}'
Response Example
Status: 200 OK |
{
"success": true,
"message": "string",
"ticketDetails": {}
}