Alvaria™ Cloud AutoFacilitate REST API v1.0.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

Overview

The Alvaria™ Cloud AutoFacilitate REST API, provided by the AutoFacilitate Server, facilitates easy integration with other systems by providing access to the endpoints needed to interact with the AutoFacilitate Feature

In order to utilize the AutoFacilitate REST API the autofacilitateapi scope is required.

Base URLs:

• https://orgId.via.aspect-cloud.net

License: License: Creative Commons Attribution 4.0 International Public License

Authentication

• oAuth2 authentication.

  • Flow: client crendentials
  • Authorization URL = https://myaspect.{region}.id.aspect-cloud.net/tokenservice/oauth2/access_token

Execute

Execute Service

Code samples

# You can also use wget
curl -X POST https://orgId.via.aspect-cloud.net/via/v2/organizations/{orgId}/autoFacilitate/execute/{vsn} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'x-api-key: string'

const fetch = require('node-fetch');
const inputBody = {
  "triggerParameters": {
    "key": "value"
  },
  "callbackUrls": [
    "https://mycompany.com/callbacks/id=123"
  ]
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'string',
  'x-api-key':'string'
};

fetch('https://orgId.via.aspect-cloud.net/via/v2/organizations/{orgId}/autoFacilitate/execute/{vsn}',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST https://orgId.via.aspect-cloud.net/via/v2/organizations/{orgId}/autoFacilitate/execute/{vsn} HTTP/1.1
Host: orgid.via.aspect-cloud.net
Content-Type: application/json
Accept: application/json
Authorization: string
x-api-key: string

POST /via/v2/organizations/{orgId}/autoFacilitate/execute/{vsn}

Starts a service

Body parameter

{
  "triggerParameters": {
    "key": "value"
  },
  "callbackUrls": [
    "https://mycompany.com/callbacks/id=123"
  ]
}

<?xml version="1.0" encoding="UTF-8" ?>
<root>
  <triggerParameters>
    <key>value</key>
  </triggerParameters>
  <callbackUrls>https://mycompany.com/callbacks/id=123</callbackUrls>
</root>

Parameters

Example responses

200 Response

{
  "message": "Successfully triggered ServerName@orgId",
  "triggerUUID": "1234"
}

Responses

Result

Get Trigger result

Code samples

# You can also use wget
curl -X GET https://orgId.via.aspect-cloud.net/via/v2/organizations/{orgId}/autoFacilitate/result/{vsn}/triggerUUID/{triggerUUID} \
  -H 'Accept: application/json' \
  -H 'Authorization: string' \
  -H 'x-api-key: string'

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'string',
  'x-api-key':'string'
};

fetch('https://orgId.via.aspect-cloud.net/via/v2/organizations/{orgId}/autoFacilitate/result/{vsn}/triggerUUID/{triggerUUID}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET https://orgId.via.aspect-cloud.net/via/v2/organizations/{orgId}/autoFacilitate/result/{vsn}/triggerUUID/{triggerUUID} HTTP/1.1
Host: orgid.via.aspect-cloud.net
Accept: application/json
Authorization: string
x-api-key: string

GET /via/v2/organizations/{orgId}/autoFacilitate/result/{vsn}/triggerUUID/{triggerUUID}

Call this endpoint to get the result from a finished service trigger

Parameters

Example responses

400 Response

{
  "code": "400",
  "message": "Validation exception",
  "errors": [
    {
      "scope": "global",
      "reason": "Invalid request",
      "message": "The value for the channel is invalid"
    }
  ]
}

Responses

Schemas

triggerParameter

{
  "triggerParameters": {
    "key": "value"
  },
  "callbackUrls": [
    "https://mycompany.com/callbacks/id=123"
  ]
}

Properties

triggerParameters

{
  "key": "value"
}

Properties

callbackUrls

[
  "https://mycompany.com/callbacks/id=123"
]

Properties

urls

"https://mycompany.com/callbacks/id=123"

Properties

ErrorResponse

{
  "code": "400",
  "message": "Validation exception",
  "errors": [
    {
      "scope": "global",
      "reason": "Invalid request",
      "message": "The value for the channel is invalid"
    }
  ]
}

Properties

Error

{
  "scope": "global",
  "reason": "Invalid request",
  "message": "The value for the channel is invalid"
}

Properties

triggerResult

{
  "message": "Successfully triggered ServerName@orgId",
  "triggerUUID": "1234"
}

Properties