Get Object
This topic provides an example of a JSON response for a get object operation.
General Information
-
In the Operation Name field, enter Get Object (JSON) as the operation name.
-
From the Operation Type drop-down list, select Get Object.
-
In the Authentication URL field, enter the URL specific to the get object.
-
In the HTTP Method drop-down list, select POST.
Header and Body
The Header has the data keys and their corresponding values. These key value pairs will be sent as part of the Header in the HTTP Request.
The HTTP body is used for posting the data with a request. The body has two data entry types, Form Data and Raw. You can use either of them for get object.
In the Raw field, enter the JSON payload for get object.
In the following screenshot, the $nativeIdentity$ signifies the AccountID (identity attribute) in the plan or during getObject operation. For example, nativeIdentity is used along with the keyword as follows:
getobject: $getObject.nativeIdentity$
This $nativeIdentity$ can be used in the Authentication URL.
Response Information
The Root Path is the common path present in the JSON response. The Success Code is the successful HTTP response code expected by the respective Web Service operation. By default, the success code is 2**.
Response Mapping
To refer to the raw JSON response on which the Response Information schema is mapped, refer to Configuration for Response.
