callout
This topic describes the verbs, command-line arguments, and API parameters available for the callout noun in the BMC Cloud Lifecycle Management SDK.
create
Use callout-create from the command line to create a new callout.
Use callout_create in the API to create a new callout. This command returns a Callout Python object with the same attributes and relationships.
obj.guid # returns the GUID
obj.name # returns the name
...
Command-line argument | API parameter | Description | Required? |
|---|---|---|---|
--calloutname | callout_name | Name of the callout. | Yes |
--callouttype | callout_type | Name or GUI of the callout type. | Yes |
--calloutweight | callout_weight | Numerical weight to assign to the new callout. |
|
--notify | notification | Indicates that this is a notification callout, so the provided operation will not fail even if the callout malfunctions. This parameter does not need a value. |
|
--attr | work_flow_name | Value for each access attribute defined for the callout type |
|
--waitfor |
| Time in seconds to wait for response from the server, otherwise return running task details. |
|
| gcac | GenericCloudAPIClient instance/user authentication. |
|
list
Use callout-list from the command line to list available callouts.
Use callout_list to list available callouts using the API. This command returns a list of Callout API objects with the same attributes and relationships.
obj[n].guid returns the GUID
obj[n].name returns the name
...
Command-line argument | API parameter | Description | Required? |
|---|---|---|---|
-l |
| List all fields. This parameter does not need a value. |
|
-u |
| List only GUIDs. This parameter does not need a value. |
|
-n |
| List only names. This parameter does not need a value. |
|
-s |
| List GUIDs, names, and status (if applicable). This parameter does not need a value. |
|
-k |
| List the field names specified as the value for this parameter. |
|
--filter | filters | Filter the output according to the specified criteria. |
|
| gcac | GenericCloudAPIClient instance/user authentication. |
|
map-to
Use callout-map-to from the command line to map object model operations to a callout.
Use callout_map in the API to map object model operations to a callout. This command affects a Callout API object.
obj.guid # returns the GUID
obj.name # returns the name
...
Command-line argument | API parameter | Description | Required? |
|---|---|---|---|
--callout | callout | Name or GUID of the callout. | Yes |
--preoperation | preOperation | The operation before which this callout will be invoked. | Yes |
--postoperation | postOperation | The operation after which this callout will be invoked. | Yes |
--callouttype | calloutType | Name or GUID of the callout type. |
|
--waitfor |
| Time in seconds to wait for a response from the server, otherwise return running task details. |
|
| gcac | GenericCloudAPIClient instance/user authentication. |
|
unmap-to
Use callout-unmap-to from the command line to unmap object model operations from a callout.
Use callout_unmap in the API to unmap object model operations from a callout. This command affects a Callout API object.
obj.guid # returns the GUID
obj.name # returns the name
...
Command-line argument | API parameter | Description | Required? |
|---|---|---|---|
--callout | callout | Name or GUID of the callout. | Yes |
--preoperation | preOperation | Operation for which mapping with the callout is removed | Yes |
--postoperation | postOperation | Operation for which mapping with the callout is removed | Yes |
--callouttype | calloutType | Name or GUID of the callout type. |
|
--waitfor |
| Time in seconds to wait for a response from the server, otherwise return running task details. |
|
| gcac | GenericCloudAPIClient instance/user authentication. |
|