Catalogs APIs
This topic describes the REST APIs for the catalogs in BMC Helix Automation Console.
The base URL for the Catalogs API is: https://<serverName>/api/v1
GET/api/v1/catalogs
Retrieves all the catalogs that are available in Automation Console.
Request body: No parameters
Responses
Code | Description |
200 | OK |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
GET/api/v1/catalogs/tssa
Retrieves all the catalogs defined in TrueSight Server Automation.
Request body
Parameter | Description |
|---|---|
size | Specifies the number of items to be displayed on a single page. Default value: 100 |
from | Retrieves catalogs for a specified page number. The start value is 0. By default, all results appear on a single page. Default value: 0 |
type | Type |
Responses
Code | Description |
200 | OK |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
GET/api/v1/catalogs/tssa/{catalogId}
Retrieves a specific catalog from TrueSight Server Automation.
Request body
Parameter | Description |
catalogId | Specific catalog ID |
Responses
Code | Description |
200 | OK |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
GET/api/v1/catalogs/{catalogId}
Retrieves a specific catalog from BMC Helix Automation Console.
Request body
Parameter | Description |
catalogId | Specific catalog ID |
Responses
Code | Description |
200 | OK |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
post/api/v1/catalogs
Creates a catalog from TrueSight Server Automation in Automation Console.
Request body: No parameters
Responses
Code | Description |
200 | OK |
201 | Created |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
Sample request
"bsa_catalog": {
"array": true,
"bigDecimal": true,
"bigInteger": true,
"binary": true,
"boolean": true,
"containerNode": true,
"double": true,
"float": true,
"floatingPointNumber": true,
"int": true,
"integralNumber": true,
"long": true,
"missingNode": true,
"nodeType": "ARRAY",
"null": true,
"number": true,
"object": true,
"pojo": true,
"short": true,
"textual": true,
"valueNode": true
},
"created_at": 0,
"created_by": "string",
"id": 0,
"is_enabled": true,
"last_updated": 0,
"modified_at": 0,
"name": "string",
"next_scheduled_update": 0,
"properties": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"schedules": {
"array": true,
"bigDecimal": true,
"bigInteger": true,
"binary": true,
"boolean": true,
"containerNode": true,
"double": true,
"float": true,
"floatingPointNumber": true,
"int": true,
"integralNumber": true,
"long": true,
"missingNode": true,
"nodeType": "ARRAY",
"null": true,
"number": true,
"object": true,
"pojo": true,
"short": true,
"textual": true,
"valueNode": true
}
}
PUT/api/v1/catalogs/{catalogId}
Updates catalog details, such as schedule for a specific catalog ID.
Request body
Parameter | Description |
catalogId | Specifies a catalog ID |
Responses
Code | Description |
200 | OK |
201 | Created |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
Sample request
"bsa_catalog": {
"array": true,
"bigDecimal": true,
"bigInteger": true,
"binary": true,
"boolean": true,
"containerNode": true,
"double": true,
"float": true,
"floatingPointNumber": true,
"int": true,
"integralNumber": true,
"long": true,
"missingNode": true,
"nodeType": "ARRAY",
"null": true,
"number": true,
"object": true,
"pojo": true,
"short": true,
"textual": true,
"valueNode": true
},
"created_at": 0,
"created_by": "string",
"id": 0,
"is_enabled": true,
"last_updated": 0,
"modified_at": 0,
"name": "string",
"next_scheduled_update": 0,
"properties": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"schedules": {
"array": true,
"bigDecimal": true,
"bigInteger": true,
"binary": true,
"boolean": true,
"containerNode": true,
"double": true,
"float": true,
"floatingPointNumber": true,
"int": true,
"integralNumber": true,
"long": true,
"missingNode": true,
"nodeType": "ARRAY",
"null": true,
"number": true,
"object": true,
"pojo": true,
"short": true,
"textual": true,
"valueNode": true
}
}
delete/api/v1/catalogs/{catalogId}
Deletes a specific catalog from Automation Console.
Request body
Parameter | Description |
catalogId | Specifies a catalog ID |
Responses
Code | Description |
200 | OK |
204 | |
401 | Unauthorized |
403 | Forbidden |