DOCUMENTATIONAPI REFERENCEAI-Link
DownloadsSupport
Loading search results...
Organizations

Organizations

List All

This REST API finds all organizations in the instance. This call is limited to a user with the SUPERUSER priviledge since it crosses Organizational boundaries.

HTTP REQUEST: GET 

GET/api/1.0/orgs
RESPONSES
CodeDescription
200Success.
401This error will occur if calling user does not have access right for the API.
503This error will occur if Design Center APIs are not enabled.

Organization List & Create

HTTP REQUEST: GET

List all Organizations this user has access to. SuperUser has access to all, but still requires API Superuser to execute.

GET/api/1.0/org
RESPONSES
CodeDescription
200Success.
401This error will occur if calling user does not have access right for the API.
404This error will occur if the org identified by orgId does not exist.
500A server error occurred. Check the logs for more details.
200 Response Body
{
  "status": {
    "i18n_message": "response.ok",
    "message": "OK"
  },
  "response": [
    {
      "id": "default",
      "name": "default",
      "NumberOfUsers": 1
    },
    {
      "id": "3882c0b2-b285-4cf1-7308-91048da5b4eb",
      "name": "Other Organization",
      "NumberOfUsers": 0
    }
  ]
}

HTTP REQUEST: POST

Create a new Organization

POST/api/1.0/org
QUERY PARAMETERS
NameTypeDescription
namestringName for the new organization
portintegerPort for the new organization
currentOrgIdstringOrganization to which the user making the request belongs (for example, default)
RESPONSES
CodeDescription
200Success.
401This error will occur if calling user does not have access right for the API.
404This error will occur if the org identified by orgId does not exist.
500A server error occurred. Check the logs for more details.
200 Response Body
{
  "status": {
    "i18n_message": "response.ok",
    "message": "OK"
  },
  "response": {
    "id": "fdddd657-7ae7-45fe-49d6-d3ae1ea3ec65",
    "name": "new organization"
  }
}

Organization Update & Delete

HTTP REQUEST: POST

Update an existing Organization

POST/api/1.0/org/{orgId}
URI PARAMETERS
NameTypeDescription
orgIdstringThe Organization ID (UUID) for which you are querying.
RESPONSES
CodeDescription
200Success.
401This error will occur if calling user does not have access right for the API.
404This error will occur if the org identified by orgId does not exist.
500A server error occurred. Check the logs for more details.
Request Body
{
  "name": "New Name"
}
200 Response Body
{
  "status": {
    "i18n_message": "response.ok",
    "message": "OK"
  },
  "response": {
    "id": "fdddd657-7ae7-45fe-49d6-d3ae1ea3ec65",
    "name": "New Name"
  }
}

HTTP REQUEST: DELETE

Delete Organization identified by orgID UUID.

DELETE/api/1.0/org/{orgId}
URI PARAMETERS
NameTypeDescription
orgIdstringThe Organization ID (UUID) for which you are querying.
RESPONSES
CodeDescription
200Success.
401This error will occur if calling user does not have access right for the API.
404This error will occur if the org identified by orgId does not exist.
500A server error occurred. Check the logs for more details.
200 Response Body
{
  "status": {
    "i18n_message": "response.ok",
    "message": "OK"
  },
  "response": {
    "id": "3882c0b2-b285-4cf1-7308-91048da5b4eb",
    "name": "Organization"
  }
}