Another look at the REST API and the areas it covers -
We have a situation today where we have v1 and v2 APIs.
OIC V1 and ICS V2.
OIC V1 -
ICS V2 -
Tip: Use ICS v2
The base URL is highlighted in blue below -
Let's try out some of them -
https://baseUrl:443/icsapis/v2/environment/trackingdb
returns salient information, such as retention period etc.
I can use the following API to purge the tracking DB -
/icsapis/v2/environment/trackingdb/purge
Here I retrieve my connections and test my Service Cloud connection
/icsapis/v2/connections
Note the ID: "id": "AANC_SERVICECLOUD",
/icsapis/v2/connections/AANC_SERVICECLOUD
gives me some more details -
I can test the Connection via the following request -
/icsapis/v2/connections/AANC_SERVICECLOUD/test
The test is just a ping on the wsdl.
Here is an example of retrieving integrations and the all important id-
/icsapis/v2/integrations
id is simple a concatenation of integration name and version number.
Now let's clone it using -
/icsapis/v2/integrations/{id}/clone
Validate in OIC -
As we say in Ireland, great stuff!
We have a situation today where we have v1 and v2 APIs.
OIC V1 and ICS V2.
OIC V1 -
ICS V2 -
Tip: Use ICS v2
The base URL is highlighted in blue below -
Let's try out some of them -
Environment
https://baseUrl:443/icsapis/v2/environment
https://baseUrl:443/icsapis/v2/environment/trackingdb
returns salient information, such as retention period etc.
I can use the following API to purge the tracking DB -
/icsapis/v2/environment/trackingdb/purge
Connections
Here I retrieve my connections and test my Service Cloud connection
/icsapis/v2/connections
Note the ID: "id": "AANC_SERVICECLOUD",
/icsapis/v2/connections/AANC_SERVICECLOUD
gives me some more details -
I can test the Connection via the following request -
/icsapis/v2/connections/AANC_SERVICECLOUD/test
The test is just a ping on the wsdl.
Integrations
Here is an example of retrieving integrations and the all important id-
/icsapis/v2/integrations
id is simple a concatenation of integration name and version number.
Now let's clone it using -
/icsapis/v2/integrations/{id}/clone
Validate in OIC -
As we say in Ireland, great stuff!
No comments:
Post a Comment