Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
| Scroll ignore | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||
Scroll export button scope current template-id 4fda9400-a7df-4ede-a95f-e4ae5fcf4796 caption Download this Page add-on Scroll PDF Exporter
| scope | current |
|---|---|
| template-id | 4fda9400-a7df-4ede-a95f-e4ae5fcf4796 |
| caption | Download this Page |
| add-on | Scroll PDF Exporter |
You can retrieve the details of a Service Catalog using the following API Request with details such as Instance, Category ID, and Catalog Type ID.
To authenticate the below API, see API Authentication and Authorization.
| Service Name | HTTP Method |
|---|---|
| SR_GetServiceCatalogDetails | POST |
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"ServiceName": "SR_GetServiceCatalogDetails",
"objCommonParameters": {
"ServiceRequestPropertyContract": {
"CategoryOrCatalog": "CATEGORY",
"UserID": "11",
"Instance": "IT Tec",
"SearchKeyword": "",
"EntitledService": false,
"OrgID": 1,
"CategoryID": 0,
"CatalogTypeID": 0
},
"_ProxyDetails": {
"AuthType": "APIKEY",
"APIKey": "XXXXX",
"ProxyID": 0,
"OrgID": 1,
"ReturnType": "JSON"
}
}
}
|
Request Parameters
| Parameter Name | Type | Description | Mandatory | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
CategoryOrCatalog |
| Name of the Category or the Catalog. |
| ||||||||||||
UserID |
| Unique Identification number of the User. |
| ||||||||||||
Instance |
| Name of the Instance. For Example: Info |
| ||||||||||||
SearchKeyword |
| Keyword of the required SR for searching. |
| ||||||||||||
EntitledService |
| Is the Catalog entitled with a Service? |
| ||||||||||||
OrgID |
| Unique Identification number of the Organization. |
| ||||||||||||
CategoryID |
| Unique Identification number of the Category. |
| ||||||||||||
CatalogTypeID |
| Unique Identification number of the Catalog Type. |
|
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"Errors": "",
"Message": "",
"Output": "",
"TokenID": "",
"OrgID": 0,
"OutputObject": {
"Details": {
"CatalogDetail": [
{
"CategoryID": 35,
"Org_ID": 1,
"Sup_Function": " Info",
"ShortCategoryName": "Approval Type",
"CategoryName": "Approval Type",
"CategoryDescription": "Testing Types of Approval",
"ImageName": null,
"Sort_Order": 0,
"IsActive": true,
"Parent_CategoryID": null,
"IsG lobal": false,
"AncestorParent_CategoryID": 0,
"IsLeafCategory": 1,
"CategoryBGColor": null
},
{
" CategoryID": 33,
"Org_ID": 1,
"Sup_Function": " Info",
"ShortCategoryName": "category1",
"CategoryName": "category1",
"CategoryDescription ": "",
"ImageName": null,
"Sort_Order": 0,
"IsActive": true,
"Parent_CategoryID": null,
"IsGlobal":false,
"AncestorParent_CategoryID": 0,
"IsLeafCategory": 1,
"CategoryBGColor": "#d41b1b"
}
],
"Base Url": "http: //<Customer_URL>/http://<Customer_URL>//v54-sp2- dev-sr-serviceimg-attachments"
}
}
}
|
Status and Error Codes
For more information, see Status and Error Messages.
| Scroll ignore | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||
|