View Integration

GET /event-system/integrations/{id}
Copied
Arrow
                https://api.ocamba.com/v2/ocamba/event-system/integrations/{id}

Retrieves the details of an Integration that has previously been created if a valid identifier was provided

path Parameters
Arrow
Name
Description
idstringrequired
Unique identifier for the object defined as a path parameter.


Example: 12345
Response status codes
Arrow
200 - OK
Arrow
Name
Description
items[ integration ]
An array of all created items.
Integration
Name
Description
actions[ action ]
Array of integration actions objects.
Action
Name
Description
create_timedateTime
Timezone: GMT.


Example: 2021-07-30 12:50:13
descriptionstring
The detailed Action description.


Example: Creates a Ticket
enginestring
Action engine.


Example: email

Possible values: http | email
idstring
The ID of the action, generated by Ocamba API.


Example: 1014
integration_idstring
The ID of the integration.


Example: 10014
itemstring
The Action item.


Example: Ticket
namestring
The Action name.


Example: Create Ticket
propertiesproperties
The Action properties map.
Properties
Name
Description
labellabel
The key of properties maps.


Example: label
Label
Name
Description
descriptionstring
The Designer description.


Example: design description
keystring
The Designer key.


Example: url
requiredboolean
The Designer required.


Example: true
typestring
The Designer type.


Example: string
update_timedateTime
Timezone: GMT.


Example: 2021-07-30 12:50:13
audiencestring
Integration audiece.


Example: public

Possible values: private | public
create_timedateTime
Timezone: GMT.


Example: 2021-07-30 12:50:13
descriptionstring
The detailed integration description.


Example: Description of integration
events[ event ]
Array of integration events objects.
Event
Name
Description
create_timedateTime
Timezone: GMT.


Example: 2021-07-30 12:50:13
descriptionstring
The detailed Event description.


Example: Creates a Event
idstring
The ID of the event, generated by Ocamba API.


Example: 1026
integration_idstring
The ID of the integration.


Example: 10002
itemstring
The Event item.


Example: item
namestring
The Event name.


Example: Create Event
update_timedateTime
Timezone: GMT.


Example: 2021-07-30 12:50:13
homepagestring (url)
The integration homepage.


Example: https://delsystems.net/index.htm
idstring
The ID of the dashboard, generated by Ocamba API.


Example: 10014
logostring (url)
The integration icon.


Example: https://www.google.com/search?q=logo&rlz=1C5CHFA_enRS985RS988
namestring
The integration name.


Example: Integration
update_timedateTime
Timezone: GMT.


Example: 2021-07-30 12:50:13
versionstring
The integration version.


Example: 1.1.10
totalinteger
A total number of items.


Example: 1
tip
1 If you don't know the integration id, list the integrations to find it.
Response examples
Copied
Arrow
200 Arrow
  • 200
{
  "total": 1,
  "items": [
    {
      "id": "10014",
      "name": "Integration",
      "description": "Description of integration",
      "logo": "https://www.google.com/search?q=logo&rlz=1C5CHFA_enRS985RS988",
      "homepage": "https://delsystems.net/index.htm",
      "version": "1.1.10",
      "audience": "public",
      "events": [
        {
          "id": "1026",
          "integration_id": "10002",
          "name": "Create Event",
          "item": "item",
          "description": "Creates a Event",
          "create_time": "2021-07-30 12:50:13",
          "update_time": "2021-07-30 12:50:13"
        }
      ],
      "actions": [
        {
          "id": "1014",
          "integration_id": "10014",
          "name": "Create Ticket",
          "item": "Ticket",
          "engine": "email",
          "properties": {
            "label": {
              "key": "url",
              "type": "string",
              "description": "design description",
              "required": true
            }
          },
          "description": "Creates a Ticket",
          "create_time": "2021-07-30 12:50:13",
          "update_time": "2021-07-30 12:50:13"
        }
      ],
      "create_time": "2021-07-30 12:50:13",
      "update_time": "2021-07-30 12:50:13"
    }
  ]
}