Callout create request

Description

This API creates a Callout object.

API stability classification

API overview

HTTP method	URI	Return type	Return type multiplicity
POST	csm/Callout	void	Not applicable

HTTP request message

Query string parameters

This API does not use query string parameters.

Request message headers

This API uses only common headers listed in HTTP-request-and-response-headers.

Request message body

This API uses the following objects in the request message body JSON.

Top-level objects

Name	Type	Multi- plicity	Description
callbackURL	String	0..1	URL to call when the operation finishes
postCallout	String	0..1	Identifier of a callout to run after the operation executes
preCallout	String	0..1	Identifier of a callout to run before the operation executes
timeout	Integer	0..1	Timeout setting. For more information about using the timeout, see Synchronous-and-asynchronous-operations. Timeout values: 0: Immediate timeout -1: Uses the system default timeout value 1..*: Times out in the specified number of seconds
operationParams	OperationParameter	1	Array of input parameters. The following table contains the list of input parameters. For information about setting up the input parameters, see Passing-input-parameters-with-an-API-request.

Input parameters to include in operationParams

Name	Type	Multi- plicity	Description
callout	Callout	1	The callout object to create

HTTP response message

Response message headers

This API uses only common headers listed in HTTP-request-and-response-headers.

Response message body

The response message body contains a Task object.

Example

The following example shows an HTTP request that creates a callout:

POST /csm/callout
Host: apiserver.calbro.com:8080
Authentication-token: AQIC5wM2LY4Sfcx705TK5UqUK6Ythuk1tVWjHMl7/rpY0Ys=@REGUSER431983

{
"timeout":-1,
"preCallout":"",
"postCallout":"",
"operationParams":[
    {
     "name":"callout",
     "type":"com.bmc.cloud.model.beans.Callout",
     "multiplicity":"1",
     "value":{
       "cloudClass":"com.bmc.cloud.model.beans.Callout",
       "name":"HTTP",
       "accessValues":[
          {
           "cloudClass":"com.bmc.cloud.model.beans.AccessAttributeValue",
           "accessAttribute":{
             "cloudClass":"com.bmc.cloud.model.beans.AccessAttribute",
             "datatype":"STRING",
             "description":"FMQA_Attr",
             "guid":"cf61ee47-2c26-49fc-bc69-70a6166c6196",
             "isPassword":false,
             "modifiableWithoutRestart":false,
             "name":"URL",
             "calloutType":"0761b275-5d61-4762-8664-18657ba39b27"
            },
           "attributeValue":"http://10.128.244.231:9091",
           "name":"URL"
          },
          {
           "cloudClass":"com.bmc.cloud.model.beans.AccessAttributeValue",
           "accessAttribute":{
             "cloudClass":"com.bmc.cloud.model.beans.AccessAttribute",
             "datatype":"STRING",
             "description":"Mime headers",
             "guid":"1a300939-0c81-434c-9af2-870f393f0bb1",
             "isOptional":false,
             "isPassword":false,
             "modifiableWithoutRestart":false,
             "name":"CustomHeader",
             "calloutType":"0761b275-5d61-4762-8664-18657ba39b27"
            },
           "attributeValue":"Authorization:Basic YnBwbXdzX2ludGVybmFsOjVOc1Npc2wrcXMwRWdyWDJMbUlsclE9PQ==,passwordEncrypted:true",
           "name":"CustomHeader"
          }
        ],
       "calloutType":"0761b275-5d61-4762-8664-18657ba39b27",
       "description":"Http Callout",
       "isNotification":true,
       "postOperation":[
         "/providedOperation/93fc931c-93d6-414d-868c-af83d4a89179",
         "/providedOperation/21a32c45-9c89-41c4-95f0-2de799522771",
         "/providedOperation/3e7aea36-d804-480c-9238-e71f9d7c297a",
         "/providedOperation/1df775f8-bc90-4640-b03e-7fd9244198cf",
         "/providedOperation/b1123f21-1df2-4595-9c18-3a28e99aceee"
        ]
      }
    }
  ]
}

The following example shows an HTTP request that creates an asynchronous callout:

{
   "timeout": -1,
   "preCallout": "",
   "postCallout": "",
   "operationParams": [
        {
           "name": "callout",
           "type": "com.bmc.cloud.model.beans.Callout",
           "multiplicity": "1",
           "value": {
               "cloudClass": "com.bmc.cloud.model.beans.Callout",
               "accessValues": [
                    {
                       "cloudClass": "com.bmc.cloud.model.beans.AccessAttributeValue",
                       "accessAttribute": {
                           "cloudClass": "com.bmc.cloud.model.beans.AccessAttribute",
                           "datatype": "STRING",
                           "description": "AO Callout AccessAttribute",
                           "guid": "8ecacc22-6c64-467c-8ef3-4eb0864646a3",
                           "isPassword": false,
                           "name": "AO_WORKFLOW"
                        },
                       "attributeValue": "{\"WFName\":\":Recording_Callout:Record\"}",
                       "guid": "cf7f6810-e0e1-4f18-8c69-0a8a451183e6",
                       "name": "AO_WORKFLOW Value"
                    }
                ],
               "calloutType": "b7c39e21-8631-41ea-a68e-129e1d2f26d1",
               "description": "AO Callout Async Test",
               "guid": "c62c661a-e48a-4883-8693-510dc3c7f494",
               "name": "AO Callout Async Test",
               "weight": 20,
                " isAsynchronous": true,
               "preOperation": [
                   "/providedoperation/60fff3da-d974-4075-bcc7-98f6da25d284"
                ]
            }
        }
    ]
}