MyRapidi
MyRapidi

Search our Wiki

Read Design on Connection

Below you see an example on how to start the Read Design process on a specific connection. Examples both in JSON and JSONAPI are provided.

NOTE: Remember to substitute the token (after Bearer) and the service id (the "[SERVICE ID]" below) to your own token and service id.

JSON:

curl 
  -H "Authorization: Bearer [API SECURITY TOKEN]"
  -H "Content-Type: application/json" 
  -H "Accept: application/json"
  -X POST
  https://api.myrapidi.com/api/v2/service/[SERVICE ID]/connections/2/readdesign

The out-put for this example would be:

{
  "threadid":"20180926090450Thread",
  "message":"Read Design Started.\u003cbr/\u003e"
}

JSONAPI:

curl 
  -H "Authorization: Bearer [API SECURITY TOKEN]"
  -H "Content-Type: application/vnd.api+json" 
  -H "Accept: application/vnd.api+json"
  -X POST
  https://api.myrapidi.com/api/v2/service/[SERVICE ID]/connections/2/readdesign

The out-put for this example would be:

{
  "data":{
    "type":"messages",
    "attributes":{
      "threadid":"20180926090450Thread",
      "message":"Read Design Started.\u003cbr/\u003e"
    }
  }
}

In order for you to view the following messages run the 'get message' command - please find the description under Messages.