Interloop_Api API Reference

undefined
Request Content-Types: application/json, application/x-www-form-urlencoded, application/xml, text/xml
Response Content-Types: application/json, application/xml, text/xml, application/javascript, text/javascript
Version: 1.0.0

Appuser

Find a related item by id for accessTokens.

GET /Appusers/{id}/accessTokens/{fk}
fk

Foreign key for accessTokens

type
string (JSON)
in
path
id

Appuser id

type
string (JSON)
in
path
200 OK

Request was successful

Response Example (200 OK)
{
  "id": "string",
  "ttl": "number (double)",
  "scopes": [
    "string"
  ],
  "created": "string (date-time)",
  "userId": "string"
}

Delete a related item by id for accessTokens.

DELETE /Appusers/{id}/accessTokens/{fk}
fk

Foreign key for accessTokens

type
string (JSON)
in
path
id

Appuser id

type
string (JSON)
in
path
204 No Content

Request was successful

Update a related item by id for accessTokens.

PUT /Appusers/{id}/accessTokens/{fk}
undefined
fk

Foreign key for accessTokens

type
string (JSON)
in
path
id

Appuser id

type
string (JSON)
in
path
Request Example
{
  "id": "string",
  "ttl": "number (double)",
  "scopes": [
    "string"
  ],
  "created": "string (date-time)",
  "userId": "string"
}
200 OK

Request was successful

Response Example (200 OK)
{
  "id": "string",
  "ttl": "number (double)",
  "scopes": [
    "string"
  ],
  "created": "string (date-time)",
  "userId": "string"
}

Find a related item by id for attachments.

GET /Appusers/{id}/attachments/{fk}
fk

Foreign key for attachments

type
string (JSON)
in
path
id

Appuser id

type
string (JSON)
in
path
200 OK

Request was successful

Response Example (200 OK)
{
  "name": "string",
  "type": "string",
  "url": "string",
  "id": "string",
  "ownerId": "string",
  "appuserId": "string",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)"
}

Delete a related item by id for attachments.

DELETE /Appusers/{id}/attachments/{fk}
fk

Foreign key for attachments

type
string (JSON)
in
path
id

Appuser id

type
string (JSON)
in
path
204 No Content

Request was successful

Update a related item by id for attachments.

PUT /Appusers/{id}/attachments/{fk}
undefined
fk

Foreign key for attachments

type
string (JSON)
in
path
id

Appuser id

type
string (JSON)
in
path
Request Example
{
  "name": "string",
  "type": "string",
  "url": "string",
  "id": "string",
  "ownerId": "string",
  "appuserId": "string",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)"
}
200 OK

Request was successful

Response Example (200 OK)
{
  "name": "string",
  "type": "string",
  "url": "string",
  "id": "string",
  "ownerId": "string",
  "appuserId": "string",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)"
}

Find a related item by id for teams.

GET /Appusers/{id}/teams/{fk}
fk

Foreign key for teams

type
string (JSON)
in
path
id

Appuser id

type
string (JSON)
in
path
200 OK

Request was successful

Response Example (200 OK)
{
  "name": "string",
  "ownerId": "string",
  "id": "string",
  "deletedAt": "string (date-time)",
  "_isDeleted": "boolean",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)"
}

Delete a related item by id for teams.

DELETE /Appusers/{id}/teams/{fk}
fk

Foreign key for teams

type
string (JSON)
in
path
id

Appuser id

type
string (JSON)
in
path
204 No Content

Request was successful

Update a related item by id for teams.

PUT /Appusers/{id}/teams/{fk}
undefined
fk

Foreign key for teams

type
string (JSON)
in
path
id

Appuser id

type
string (JSON)
in
path
Request Example
{
  "name": "string",
  "ownerId": "string",
  "id": "string",
  "deletedAt": "string (date-time)",
  "_isDeleted": "boolean",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)"
}
200 OK

Request was successful

Response Example (200 OK)
{
  "name": "string",
  "ownerId": "string",
  "id": "string",
  "deletedAt": "string (date-time)",
  "_isDeleted": "boolean",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)"
}

Add a related item by id for teams.

PUT /Appusers/{id}/teams/rel/{fk}
undefined
fk

Foreign key for teams

type
string (JSON)
in
path
id

Appuser id

type
string (JSON)
in
path
Request Example
{
  "id": "string",
  "teamId": "string",
  "appuserId": "string"
}
200 OK

Request was successful

Response Example (200 OK)
{
  "id": "string",
  "teamId": "string",
  "appuserId": "string"
}

Remove the teams relation to an item by id.

DELETE /Appusers/{id}/teams/rel/{fk}
fk

Foreign key for teams

type
string (JSON)
in
path
id

Appuser id

type
string (JSON)
in
path
204 No Content

Request was successful

Check the existence of teams relation to an item by id.

HEAD /Appusers/{id}/teams/rel/{fk}
fk

Foreign key for teams

type
string (JSON)
in
path
id

Appuser id

type
string (JSON)
in
path
200 OK

Request was successful

Response Example (200 OK)
"boolean"

Find a related item by id for role.

GET /Appusers/{id}/role/{fk}
fk

Foreign key for role

type
string (JSON)
in
path
id

Appuser id

type
string (JSON)
in
path
200 OK

Request was successful

Response Example (200 OK)
{
  "label": "string",
  "key": "string",
  "description": "string",
  "visibility": "string",
  "id": "string"
}

Delete a related item by id for role.

DELETE /Appusers/{id}/role/{fk}
fk

Foreign key for role

type
string (JSON)
in
path
id

Appuser id

type
string (JSON)
in
path
204 No Content

Request was successful

Update a related item by id for role.

PUT /Appusers/{id}/role/{fk}
undefined
fk

Foreign key for role

type
string (JSON)
in
path
id

Appuser id

type
string (JSON)
in
path
Request Example
{
  "label": "string",
  "key": "string",
  "description": "string",
  "visibility": "string",
  "id": "string"
}
200 OK

Request was successful

Response Example (200 OK)
{
  "label": "string",
  "key": "string",
  "description": "string",
  "visibility": "string",
  "id": "string"
}

Add a related item by id for role.

PUT /Appusers/{id}/role/rel/{fk}
undefined
fk

Foreign key for role

type
string (JSON)
in
path
id

Appuser id

type
string (JSON)
in
path
Request Example
{
  "id": "string",
  "appRoleId": "string",
  "appuserId": "string"
}

Request was successful

Response Example (200 OK)
{
  "id": "string",
  "appRoleId": "string",
  "appuserId": "string"
}

Remove the role relation to an item by id.

DELETE /Appusers/{id}/role/rel/{fk}
fk

Foreign key for role

type
string (JSON)
in
path
id

Appuser id

type
string (JSON)
in
path
204 No Content

Request was successful

Check the existence of role relation to an item by id.

HEAD /Appusers/{id}/role/rel/{fk}
fk

Foreign key for role

type
string (JSON)
in
path
id

Appuser id

type
string (JSON)
in
path
200 OK

Request was successful

Response Example (200 OK)
"boolean"

Find a related item by id for notifications.

GET /Appusers/{id}/notifications/{fk}
fk

Foreign key for notifications

type
string (JSON)
in
path
id

Appuser id

type
string (JSON)
in
path
200 OK

Request was successful

Response Example (200 OK)
{
  "title": "string",
  "body": "string",
  "type": "string",
  "read": "boolean",
  "entityType": "string",
  "entityId": "string",
  "actions": [
    "string"
  ],
  "id": "string",
  "recipientId": "string",
  "appuserId": "string",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)"
}

Delete a related item by id for notifications.

DELETE /Appusers/{id}/notifications/{fk}
fk

Foreign key for notifications

type
string (JSON)
in
path
id

Appuser id

type
string (JSON)
in
path
204 No Content

Request was successful

Update a related item by id for notifications.

PUT /Appusers/{id}/notifications/{fk}
undefined
fk

Foreign key for notifications

type
string (JSON)
in
path
id

Appuser id

type
string (JSON)
in
path
Request Example
{
  "title": "string",
  "body": "string",
  "type": "string",
  "read": "boolean",
  "entityType": "string",
  "entityId": "string",
  "actions": [
    "string"
  ],
  "id": "string",
  "recipientId": "string",
  "appuserId": "string",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)"
}
200 OK

Request was successful

Response Example (200 OK)
{
  "title": "string",
  "body": "string",
  "type": "string",
  "read": "boolean",
  "entityType": "string",
  "entityId": "string",
  "actions": [
    "string"
  ],
  "id": "string",
  "recipientId": "string",
  "appuserId": "string",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)"
}

Find a related item by id for starredItems.

GET /Appusers/{id}/starredItems/{fk}
fk

Foreign key for starredItems

type
string (JSON)
in
path
id

Appuser id

type
string (JSON)
in
path
200 OK

Request was successful

Response Example (200 OK)
{
  "name": "string",
  "starredOn": "string (date-time)",
  "id": "string",
  "starredItemId": "string",
  "starredItemType": "string"
}

Delete a related item by id for starredItems.

DELETE /Appusers/{id}/starredItems/{fk}
fk

Foreign key for starredItems

type
string (JSON)
in
path
id

Appuser id

type
string (JSON)
in
path
204 No Content

Request was successful

Update a related item by id for starredItems.

PUT /Appusers/{id}/starredItems/{fk}
undefined
fk

Foreign key for starredItems

type
string (JSON)
in
path
id

Appuser id

type
string (JSON)
in
path
Request Example
{
  "name": "string",
  "starredOn": "string (date-time)",
  "id": "string",
  "starredItemId": "string",
  "starredItemType": "string"
}
200 OK

Request was successful

Response Example (200 OK)
{
  "name": "string",
  "starredOn": "string (date-time)",
  "id": "string",
  "starredItemId": "string",
  "starredItemType": "string"
}

Find a related item by id for goals.

GET /Appusers/{id}/goals/{fk}
fk

Foreign key for goals

type
string (JSON)
in
path
id

Appuser id

type
string (JSON)
in
path
200 OK

Request was successful

Response Example (200 OK)
{
  "name": "string",
  "value": {},
  "dueDate": "string (date-time)",
  "id": "string",
  "ownerId": "string",
  "appuserId": "string",
  "deletedAt": "string (date-time)",
  "_isDeleted": "boolean",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)"
}

Delete a related item by id for goals.

DELETE /Appusers/{id}/goals/{fk}
fk

Foreign key for goals

type
string (JSON)
in
path
id

Appuser id

type
string (JSON)
in
path
204 No Content

Request was successful

Update a related item by id for goals.

PUT /Appusers/{id}/goals/{fk}
undefined
fk

Foreign key for goals

type
string (JSON)
in
path
id

Appuser id

type
string (JSON)
in
path
Request Example
{
  "name": "string",
  "value": {},
  "dueDate": "string (date-time)",
  "id": "string",
  "ownerId": "string",
  "appuserId": "string",
  "deletedAt": "string (date-time)",
  "_isDeleted": "boolean",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)"
}
200 OK

Request was successful

Response Example (200 OK)
{
  "name": "string",
  "value": {},
  "dueDate": "string (date-time)",
  "id": "string",
  "ownerId": "string",
  "appuserId": "string",
  "deletedAt": "string (date-time)",
  "_isDeleted": "boolean",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)"
}

Queries accessTokens of Appuser.

GET /Appusers/{id}/accessTokens
filter

(no description)

type
string (JSON)
in
query
id

Appuser id

type
string (JSON)
in
path
200 OK

Request was successful

Response Example (200 OK)
[
  {
    "id": "string",
    "ttl": "number (double)",
    "scopes": [
      "string"
    ],
    "created": "string (date-time)",
    "userId": "string"
  }
]

Creates a new instance in accessTokens of this model.

POST /Appusers/{id}/accessTokens
undefined
id

Appuser id

type
string (JSON)
in
path
Request Example
{
  "id": "string",
  "ttl": "number (double)",
  "scopes": [
    "string"
  ],
  "created": "string (date-time)",
  "userId": "string"
}
200 OK

Request was successful

Response Example (200 OK)
{
  "id": "string",
  "ttl": "number (double)",
  "scopes": [
    "string"
  ],
  "created": "string (date-time)",
  "userId": "string"
}

Deletes all accessTokens of this model.

DELETE /Appusers/{id}/accessTokens
id

Appuser id

type
string (JSON)
in
path
204 No Content

Request was successful

Counts accessTokens of Appuser.

GET /Appusers/{id}/accessTokens/count
where

Criteria to match model instances

type
string (JSON)
in
query
id

Appuser id

type
string (JSON)
in
path
200 OK

Request was successful

Response Example (200 OK)
{
  "count": "number (double)"
}

Queries attachments of Appuser.

GET /Appusers/{id}/attachments
filter

(no description)

type
string (JSON)
in
query
id

Appuser id

type
string (JSON)
in
path
200 OK

Request was successful

Response Example (200 OK)
[
  {
    "name": "string",
    "type": "string",
    "url": "string",
    "id": "string",
    "ownerId": "string",
    "appuserId": "string",
    "createdOn": "string (date-time)",
    "updatedOn": "string (date-time)"
  }
]

Creates a new instance in attachments of this model.

POST /Appusers/{id}/attachments
undefined
id

Appuser id

type
string (JSON)
in
path
Request Example
{
  "name": "string",
  "type": "string",
  "url": "string",
  "id": "string",
  "ownerId": "string",
  "appuserId": "string",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)"
}
200 OK

Request was successful

Response Example (200 OK)
{
  "name": "string",
  "type": "string",
  "url": "string",
  "id": "string",
  "ownerId": "string",
  "appuserId": "string",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)"
}

Deletes all attachments of this model.

DELETE /Appusers/{id}/attachments
id

Appuser id

type
string (JSON)
in
path
204 No Content

Request was successful

Counts attachments of Appuser.

GET /Appusers/{id}/attachments/count
where

Criteria to match model instances

type
string (JSON)
in
query
id

Appuser id

type
string (JSON)
in
path
200 OK

Request was successful

Response Example (200 OK)
{
  "count": "number (double)"
}

Queries teams of Appuser.

GET /Appusers/{id}/teams
filter

(no description)

type
string (JSON)
in
query
id

Appuser id

type
string (JSON)
in
path
200 OK

Request was successful

Response Example (200 OK)
[
  {
    "name": "string",
    "ownerId": "string",
    "id": "string",
    "deletedAt": "string (date-time)",
    "_isDeleted": "boolean",
    "createdOn": "string (date-time)",
    "updatedOn": "string (date-time)"
  }
]

Creates a new instance in teams of this model.

POST /Appusers/{id}/teams
undefined
id

Appuser id

type
string (JSON)
in
path
Request Example
{
  "name": "string",
  "ownerId": "string",
  "id": "string",
  "deletedAt": "string (date-time)",
  "_isDeleted": "boolean",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)"
}
200 OK

Request was successful

Response Example (200 OK)
{
  "name": "string",
  "ownerId": "string",
  "id": "string",
  "deletedAt": "string (date-time)",
  "_isDeleted": "boolean",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)"
}

Deletes all teams of this model.

DELETE /Appusers/{id}/teams
id

Appuser id

type
string (JSON)
in
path
204 No Content

Request was successful

Counts teams of Appuser.

GET /Appusers/{id}/teams/count
where

Criteria to match model instances

type
string (JSON)
in
query
id

Appuser id

type
string (JSON)
in
path
200 OK

Request was successful

Response Example (200 OK)
{
  "count": "number (double)"
}

Queries role of Appuser.

GET /Appusers/{id}/role
filter

(no description)

type
string (JSON)
in
query
id

Appuser id

type
string (JSON)
in
path
200 OK

Request was successful

Response Example (200 OK)
[
  {
    "label": "string",
    "key": "string",
    "description": "string",
    "visibility": "string",
    "id": "string"
  }
]

Creates a new instance in role of this model.

POST /Appusers/{id}/role
undefined
id

Appuser id

type
string (JSON)
in
path
Request Example
{
  "label": "string",
  "key": "string",
  "description": "string",
  "visibility": "string",
  "id": "string"
}
200 OK

Request was successful

Response Example (200 OK)
{
  "label": "string",
  "key": "string",
  "description": "string",
  "visibility": "string",
  "id": "string"
}

Deletes all role of this model.

DELETE /Appusers/{id}/role
id

Appuser id

type
string (JSON)
in
path
204 No Content

Request was successful

Counts role of Appuser.

GET /Appusers/{id}/role/count
where

Criteria to match model instances

type
string (JSON)
in
query
id

Appuser id

type
string (JSON)
in
path
200 OK

Request was successful

Response Example (200 OK)
{
  "count": "number (double)"
}

Queries notifications of Appuser.

GET /Appusers/{id}/notifications
filter

(no description)

type
string (JSON)
in
query
id

Appuser id

type
string (JSON)
in
path
200 OK

Request was successful

Response Example (200 OK)
[
  {
    "title": "string",
    "body": "string",
    "type": "string",
    "read": "boolean",
    "entityType": "string",
    "entityId": "string",
    "actions": [
      "string"
    ],
    "id": "string",
    "recipientId": "string",
    "appuserId": "string",
    "createdOn": "string (date-time)",
    "updatedOn": "string (date-time)"
  }
]

Creates a new instance in notifications of this model.

POST /Appusers/{id}/notifications
undefined
id

Appuser id

type
string (JSON)
in
path
Request Example
{
  "title": "string",
  "body": "string",
  "type": "string",
  "read": "boolean",
  "entityType": "string",
  "entityId": "string",
  "actions": [
    "string"
  ],
  "id": "string",
  "recipientId": "string",
  "appuserId": "string",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)"
}
200 OK

Request was successful

Response Example (200 OK)
{
  "title": "string",
  "body": "string",
  "type": "string",
  "read": "boolean",
  "entityType": "string",
  "entityId": "string",
  "actions": [
    "string"
  ],
  "id": "string",
  "recipientId": "string",
  "appuserId": "string",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)"
}

Deletes all notifications of this model.

DELETE /Appusers/{id}/notifications
id

Appuser id

type
string (JSON)
in
path
204 No Content

Request was successful

Counts notifications of Appuser.

GET /Appusers/{id}/notifications/count
where

Criteria to match model instances

type
string (JSON)
in
query
id

Appuser id

type
string (JSON)
in
path
200 OK

Request was successful

Response Example (200 OK)
{
  "count": "number (double)"
}

Queries starredItems of Appuser.

GET /Appusers/{id}/starredItems
filter

(no description)

type
string (JSON)
in
query
id

Appuser id

type
string (JSON)
in
path
200 OK

Request was successful

Response Example (200 OK)
[
  {
    "name": "string",
    "starredOn": "string (date-time)",
    "id": "string",
    "starredItemId": "string",
    "starredItemType": "string"
  }
]

Creates a new instance in starredItems of this model.

POST /Appusers/{id}/starredItems
undefined
id

Appuser id

type
string (JSON)
in
path
Request Example
{
  "name": "string",
  "starredOn": "string (date-time)",
  "id": "string",
  "starredItemId": "string",
  "starredItemType": "string"
}
200 OK

Request was successful

Response Example (200 OK)
{
  "name": "string",
  "starredOn": "string (date-time)",
  "id": "string",
  "starredItemId": "string",
  "starredItemType": "string"
}

Deletes all starredItems of this model.

DELETE /Appusers/{id}/starredItems
id

Appuser id

type
string (JSON)
in
path
204 No Content

Request was successful

Counts starredItems of Appuser.

GET /Appusers/{id}/starredItems/count
where

Criteria to match model instances

type
string (JSON)
in
query
id

Appuser id

type
string (JSON)
in
path
200 OK

Request was successful

Response Example (200 OK)
{
  "count": "number (double)"
}

Queries goals of Appuser.

GET /Appusers/{id}/goals
filter

(no description)

type
string (JSON)
in
query
id

Appuser id

type
string (JSON)
in
path
200 OK

Request was successful

Response Example (200 OK)
[
  {
    "name": "string",
    "value": {},
    "dueDate": "string (date-time)",
    "id": "string",
    "ownerId": "string",
    "appuserId": "string",
    "deletedAt": "string (date-time)",
    "_isDeleted": "boolean",
    "createdOn": "string (date-time)",
    "updatedOn": "string (date-time)"
  }
]

Creates a new instance in goals of this model.

POST /Appusers/{id}/goals
undefined
id

Appuser id

type
string (JSON)
in
path
Request Example
{
  "name": "string",
  "value": {},
  "dueDate": "string (date-time)",
  "id": "string",
  "ownerId": "string",
  "appuserId": "string",
  "deletedAt": "string (date-time)",
  "_isDeleted": "boolean",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)"
}
200 OK

Request was successful

Response Example (200 OK)
{
  "name": "string",
  "value": {},
  "dueDate": "string (date-time)",
  "id": "string",
  "ownerId": "string",
  "appuserId": "string",
  "deletedAt": "string (date-time)",
  "_isDeleted": "boolean",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)"
}

Deletes all goals of this model.

DELETE /Appusers/{id}/goals
id

Appuser id

type
string (JSON)
in
path
204 No Content

Request was successful

Counts goals of Appuser.

GET /Appusers/{id}/goals/count
where

Criteria to match model instances

type
string (JSON)
in
query
id

Appuser id

type
string (JSON)
in
path
200 OK

Request was successful

Response Example (200 OK)
{
  "count": "number (double)"
}

Create a new instance of the model and persist it into the data source.

POST /Appusers

Model instance data

Request Example
{
  "firstName": "string",
  "lastName": "string",
  "fullName": "string",
  "initials": "string",
  "avatar": "string",
  "title": "string",
  "phone": "string",
  "location": "string",
  "roles": [
    "string"
  ],
  "defaultViews": "object",
  "alertSettings": "object",
  "deactivated": "boolean",
  "realm": "string",
  "username": "string",
  "email": "string",
  "emailVerified": "boolean",
  "id": "string",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)",
  "orgId": "string",
  "starredLinks": [
    {
      "name": "string",
      "starredOn": "string (date-time)",
      "id": "string",
      "starredItemId": "string",
      "starredItemType": "string"
    }
  ]
}
200 OK

Request was successful

Response Example (200 OK)
{
  "firstName": "string",
  "lastName": "string",
  "fullName": "string",
  "initials": "string",
  "avatar": "string",
  "title": "string",
  "phone": "string",
  "location": "string",
  "roles": [
    "string"
  ],
  "defaultViews": "object",
  "alertSettings": "object",
  "deactivated": "boolean",
  "realm": "string",
  "username": "string",
  "email": "string",
  "emailVerified": "boolean",
  "id": "string",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)",
  "orgId": "string",
  "starredLinks": [
    {
      "name": "string",
      "starredOn": "string (date-time)",
      "id": "string",
      "starredItemId": "string",
      "starredItemType": "string"
    }
  ]
}

Patch an existing model instance or insert a new one into the data source.

PATCH /Appusers

Model instance data

Request Example
{
  "firstName": "string",
  "lastName": "string",
  "fullName": "string",
  "initials": "string",
  "avatar": "string",
  "title": "string",
  "phone": "string",
  "location": "string",
  "roles": [
    "string"
  ],
  "defaultViews": "object",
  "alertSettings": "object",
  "deactivated": "boolean",
  "realm": "string",
  "username": "string",
  "email": "string",
  "emailVerified": "boolean",
  "id": "string",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)",
  "orgId": "string",
  "starredLinks": [
    {
      "name": "string",
      "starredOn": "string (date-time)",
      "id": "string",
      "starredItemId": "string",
      "starredItemType": "string"
    }
  ]
}
200 OK

Request was successful

Response Example (200 OK)
{
  "firstName": "string",
  "lastName": "string",
  "fullName": "string",
  "initials": "string",
  "avatar": "string",
  "title": "string",
  "phone": "string",
  "location": "string",
  "roles": [
    "string"
  ],
  "defaultViews": "object",
  "alertSettings": "object",
  "deactivated": "boolean",
  "realm": "string",
  "username": "string",
  "email": "string",
  "emailVerified": "boolean",
  "id": "string",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)",
  "orgId": "string",
  "starredLinks": [
    {
      "name": "string",
      "starredOn": "string (date-time)",
      "id": "string",
      "starredItemId": "string",
      "starredItemType": "string"
    }
  ]
}

Replace an existing model instance or insert a new one into the data source.

PUT /Appusers

Model instance data

Request Example
{
  "firstName": "string",
  "lastName": "string",
  "fullName": "string",
  "initials": "string",
  "avatar": "string",
  "title": "string",
  "phone": "string",
  "location": "string",
  "roles": [
    "string"
  ],
  "defaultViews": "object",
  "alertSettings": "object",
  "deactivated": "boolean",
  "realm": "string",
  "username": "string",
  "email": "string",
  "emailVerified": "boolean",
  "id": "string",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)",
  "orgId": "string",
  "starredLinks": [
    {
      "name": "string",
      "starredOn": "string (date-time)",
      "id": "string",
      "starredItemId": "string",
      "starredItemType": "string"
    }
  ]
}
200 OK

Request was successful

Response Example (200 OK)
{
  "firstName": "string",
  "lastName": "string",
  "fullName": "string",
  "initials": "string",
  "avatar": "string",
  "title": "string",
  "phone": "string",
  "location": "string",
  "roles": [
    "string"
  ],
  "defaultViews": "object",
  "alertSettings": "object",
  "deactivated": "boolean",
  "realm": "string",
  "username": "string",
  "email": "string",
  "emailVerified": "boolean",
  "id": "string",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)",
  "orgId": "string",
  "starredLinks": [
    {
      "name": "string",
      "starredOn": "string (date-time)",
      "id": "string",
      "starredItemId": "string",
      "starredItemType": "string"
    }
  ]
}

Find all instances of the model matched by filter from the data source.

GET /Appusers
filter

Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ({"something":"value"})

type
string (JSON)
in
query
200 OK

Request was successful

Response Example (200 OK)
[
  {
    "firstName": "string",
    "lastName": "string",
    "fullName": "string",
    "initials": "string",
    "avatar": "string",
    "title": "string",
    "phone": "string",
    "location": "string",
    "roles": [
      "string"
    ],
    "defaultViews": "object",
    "alertSettings": "object",
    "deactivated": "boolean",
    "realm": "string",
    "username": "string",
    "email": "string",
    "emailVerified": "boolean",
    "id": "string",
    "createdOn": "string (date-time)",
    "updatedOn": "string (date-time)",
    "orgId": "string",
    "starredLinks": [
      {
        "name": "string",
        "starredOn": "string (date-time)",
        "id": "string",
        "starredItemId": "string",
        "starredItemType": "string"
      }
    ]
  }
]

Replace an existing model instance or insert a new one into the data source.

POST /Appusers/replaceOrCreate

Model instance data

Request Example
{
  "firstName": "string",
  "lastName": "string",
  "fullName": "string",
  "initials": "string",
  "avatar": "string",
  "title": "string",
  "phone": "string",
  "location": "string",
  "roles": [
    "string"
  ],
  "defaultViews": "object",
  "alertSettings": "object",
  "deactivated": "boolean",
  "realm": "string",
  "username": "string",
  "email": "string",
  "emailVerified": "boolean",
  "id": "string",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)",
  "orgId": "string",
  "starredLinks": [
    {
      "name": "string",
      "starredOn": "string (date-time)",
      "id": "string",
      "starredItemId": "string",
      "starredItemType": "string"
    }
  ]
}
200 OK

Request was successful

Response Example (200 OK)
{
  "firstName": "string",
  "lastName": "string",
  "fullName": "string",
  "initials": "string",
  "avatar": "string",
  "title": "string",
  "phone": "string",
  "location": "string",
  "roles": [
    "string"
  ],
  "defaultViews": "object",
  "alertSettings": "object",
  "deactivated": "boolean",
  "realm": "string",
  "username": "string",
  "email": "string",
  "emailVerified": "boolean",
  "id": "string",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)",
  "orgId": "string",
  "starredLinks": [
    {
      "name": "string",
      "starredOn": "string (date-time)",
      "id": "string",
      "starredItemId": "string",
      "starredItemType": "string"
    }
  ]
}

Update an existing model instance or insert a new one into the data source based on the where criteria.

POST /Appusers/upsertWithWhere

An object of model property name/value pairs

where

Criteria to match model instances

type
string (JSON)
in
query
Request Example
{
  "firstName": "string",
  "lastName": "string",
  "fullName": "string",
  "initials": "string",
  "avatar": "string",
  "title": "string",
  "phone": "string",
  "location": "string",
  "roles": [
    "string"
  ],
  "defaultViews": "object",
  "alertSettings": "object",
  "deactivated": "boolean",
  "realm": "string",
  "username": "string",
  "email": "string",
  "emailVerified": "boolean",
  "id": "string",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)",
  "orgId": "string",
  "starredLinks": [
    {
      "name": "string",
      "starredOn": "string (date-time)",
      "id": "string",
      "starredItemId": "string",
      "starredItemType": "string"
    }
  ]
}
200 OK

Request was successful

Response Example (200 OK)
{
  "firstName": "string",
  "lastName": "string",
  "fullName": "string",
  "initials": "string",
  "avatar": "string",
  "title": "string",
  "phone": "string",
  "location": "string",
  "roles": [
    "string"
  ],
  "defaultViews": "object",
  "alertSettings": "object",
  "deactivated": "boolean",
  "realm": "string",
  "username": "string",
  "email": "string",
  "emailVerified": "boolean",
  "id": "string",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)",
  "orgId": "string",
  "starredLinks": [
    {
      "name": "string",
      "starredOn": "string (date-time)",
      "id": "string",
      "starredItemId": "string",
      "starredItemType": "string"
    }
  ]
}

Check whether a model instance exists in the data source.

GET /Appusers/{id}/exists
id

Model id

type
string (JSON)
in
path
200 OK

Request was successful

Response Example (200 OK)
{
  "exists": "boolean"
}

Check whether a model instance exists in the data source.

HEAD /Appusers/{id}
id

Model id

type
string (JSON)
in
path
200 OK

Request was successful

Response Example (200 OK)
{
  "exists": "boolean"
}

Find a model instance by {{id}} from the data source.

GET /Appusers/{id}
id

Model id

type
string (JSON)
in
path
filter

Filter defining fields and include - must be a JSON-encoded string ({"something":"value"})

type
string (JSON)
in
query
200 OK

Request was successful

Response Example (200 OK)
{
  "firstName": "string",
  "lastName": "string",
  "fullName": "string",
  "initials": "string",
  "avatar": "string",
  "title": "string",
  "phone": "string",
  "location": "string",
  "roles": [
    "string"
  ],
  "defaultViews": "object",
  "alertSettings": "object",
  "deactivated": "boolean",
  "realm": "string",
  "username": "string",
  "email": "string",
  "emailVerified": "boolean",
  "id": "string",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)",
  "orgId": "string",
  "starredLinks": [
    {
      "name": "string",
      "starredOn": "string (date-time)",
      "id": "string",
      "starredItemId": "string",
      "starredItemType": "string"
    }
  ]
}

Replace attributes for a model instance and persist it into the data source.

PUT /Appusers/{id}

Model instance data

id

Model id

type
string (JSON)
in
path
Request Example
{
  "firstName": "string",
  "lastName": "string",
  "fullName": "string",
  "initials": "string",
  "avatar": "string",
  "title": "string",
  "phone": "string",
  "location": "string",
  "roles": [
    "string"
  ],
  "defaultViews": "object",
  "alertSettings": "object",
  "deactivated": "boolean",
  "realm": "string",
  "username": "string",
  "email": "string",
  "emailVerified": "boolean",
  "id": "string",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)",
  "orgId": "string",
  "starredLinks": [
    {
      "name": "string",
      "starredOn": "string (date-time)",
      "id": "string",
      "starredItemId": "string",
      "starredItemType": "string"
    }
  ]
}
200 OK

Request was successful

Response Example (200 OK)
{
  "firstName": "string",
  "lastName": "string",
  "fullName": "string",
  "initials": "string",
  "avatar": "string",
  "title": "string",
  "phone": "string",
  "location": "string",
  "roles": [
    "string"
  ],
  "defaultViews": "object",
  "alertSettings": "object",
  "deactivated": "boolean",
  "realm": "string",
  "username": "string",
  "email": "string",
  "emailVerified": "boolean",
  "id": "string",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)",
  "orgId": "string",
  "starredLinks": [
    {
      "name": "string",
      "starredOn": "string (date-time)",
      "id": "string",
      "starredItemId": "string",
      "starredItemType": "string"
    }
  ]
}

Delete a model instance by {{id}} from the data source.

DELETE /Appusers/{id}
id

Model id

type
string (JSON)
in
path
200 OK

Request was successful

Response Example (200 OK)
"object"

Patch attributes for a model instance and persist it into the data source.

PATCH /Appusers/{id}

An object of model property name/value pairs

id

Appuser id

type
string (JSON)
in
path
Request Example
{
  "firstName": "string",
  "lastName": "string",
  "fullName": "string",
  "initials": "string",
  "avatar": "string",
  "title": "string",
  "phone": "string",
  "location": "string",
  "roles": [
    "string"
  ],
  "defaultViews": "object",
  "alertSettings": "object",
  "deactivated": "boolean",
  "realm": "string",
  "username": "string",
  "email": "string",
  "emailVerified": "boolean",
  "id": "string",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)",
  "orgId": "string",
  "starredLinks": [
    {
      "name": "string",
      "starredOn": "string (date-time)",
      "id": "string",
      "starredItemId": "string",
      "starredItemType": "string"
    }
  ]
}
200 OK

Request was successful

Response Example (200 OK)
{
  "firstName": "string",
  "lastName": "string",
  "fullName": "string",
  "initials": "string",
  "avatar": "string",
  "title": "string",
  "phone": "string",
  "location": "string",
  "roles": [
    "string"
  ],
  "defaultViews": "object",
  "alertSettings": "object",
  "deactivated": "boolean",
  "realm": "string",
  "username": "string",
  "email": "string",
  "emailVerified": "boolean",
  "id": "string",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)",
  "orgId": "string",
  "starredLinks": [
    {
      "name": "string",
      "starredOn": "string (date-time)",
      "id": "string",
      "starredItemId": "string",
      "starredItemType": "string"
    }
  ]
}

Replace attributes for a model instance and persist it into the data source.

POST /Appusers/{id}/replace

Model instance data

id

Model id

type
string (JSON)
in
path
Request Example
{
  "firstName": "string",
  "lastName": "string",
  "fullName": "string",
  "initials": "string",
  "avatar": "string",
  "title": "string",
  "phone": "string",
  "location": "string",
  "roles": [
    "string"
  ],
  "defaultViews": "object",
  "alertSettings": "object",
  "deactivated": "boolean",
  "realm": "string",
  "username": "string",
  "email": "string",
  "emailVerified": "boolean",
  "id": "string",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)",
  "orgId": "string",
  "starredLinks": [
    {
      "name": "string",
      "starredOn": "string (date-time)",
      "id": "string",
      "starredItemId": "string",
      "starredItemType": "string"
    }
  ]
}
200 OK

Request was successful

Response Example (200 OK)
{
  "firstName": "string",
  "lastName": "string",
  "fullName": "string",
  "initials": "string",
  "avatar": "string",
  "title": "string",
  "phone": "string",
  "location": "string",
  "roles": [
    "string"
  ],
  "defaultViews": "object",
  "alertSettings": "object",
  "deactivated": "boolean",
  "realm": "string",
  "username": "string",
  "email": "string",
  "emailVerified": "boolean",
  "id": "string",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)",
  "orgId": "string",
  "starredLinks": [
    {
      "name": "string",
      "starredOn": "string (date-time)",
      "id": "string",
      "starredItemId": "string",
      "starredItemType": "string"
    }
  ]
}

Find first instance of the model matched by filter from the data source.

GET /Appusers/findOne
filter

Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ({"something":"value"})

type
string (JSON)
in
query
200 OK

Request was successful

Response Example (200 OK)
{
  "firstName": "string",
  "lastName": "string",
  "fullName": "string",
  "initials": "string",
  "avatar": "string",
  "title": "string",
  "phone": "string",
  "location": "string",
  "roles": [
    "string"
  ],
  "defaultViews": "object",
  "alertSettings": "object",
  "deactivated": "boolean",
  "realm": "string",
  "username": "string",
  "email": "string",
  "emailVerified": "boolean",
  "id": "string",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)",
  "orgId": "string",
  "starredLinks": [
    {
      "name": "string",
      "starredOn": "string (date-time)",
      "id": "string",
      "starredItemId": "string",
      "starredItemType": "string"
    }
  ]
}

Update instances of the model matched by {{where}} from the data source.

POST /Appusers/update

An object of model property name/value pairs

where

Criteria to match model instances

type
string (JSON)
in
query
Request Example
{
  "firstName": "string",
  "lastName": "string",
  "fullName": "string",
  "initials": "string",
  "avatar": "string",
  "title": "string",
  "phone": "string",
  "location": "string",
  "roles": [
    "string"
  ],
  "defaultViews": "object",
  "alertSettings": "object",
  "deactivated": "boolean",
  "realm": "string",
  "username": "string",
  "email": "string",
  "emailVerified": "boolean",
  "id": "string",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)",
  "orgId": "string",
  "starredLinks": [
    {
      "name": "string",
      "starredOn": "string (date-time)",
      "id": "string",
      "starredItemId": "string",
      "starredItemType": "string"
    }
  ]
}
200 OK

Request was successful

Response Example (200 OK)
{
  "count": "number (double)"
}

Count instances of the model matched by where from the data source.

GET /Appusers/count
where

Criteria to match model instances

type
string (JSON)
in
query
200 OK

Request was successful

Response Example (200 OK)
{
  "count": "number (double)"
}

Create a change stream.

POST /Appusers/change-stream
options

(no description)

type
string (JSON)
in
formData
200 OK

Request was successful

Response Example (200 OK)
"file"

Create a change stream.

GET /Appusers/change-stream
options

(no description)

type
string (JSON)
in
query
200 OK

Request was successful

Response Example (200 OK)
"file"

Login a user with username/email and password.

POST /Appusers/login
include

Related objects to include in the response. See the description of return value for more details.

type
string (JSON)
in
query
Request Example
"object"
200 OK

Request was successful

Response Example (200 OK)
"object"

Logout a user with access token.

POST /Appusers/logout
204 No Content

Request was successful

Trigger user's identity verification with configured verifyOptions

POST /Appusers/{id}/verify
id

Appuser id

type
string (JSON)
in
path
204 No Content

Request was successful

Confirm a user registration with identity verification token.

GET /Appusers/confirm
uid

(no description)

type
string
in
query
token

(no description)

type
string
in
query
redirect

(no description)

type
string
in
query
204 No Content

Request was successful

Reset password for a user with email.

POST /Appusers/reset
Request Example
"object"
204 No Content

Request was successful

Change a user's password.

POST /Appusers/change-password
oldPassword

(no description)

type
string
in
formData
newPassword

(no description)

type
string
in
formData
204 No Content

Request was successful

Reset user's password via a password-reset token.

POST /Appusers/reset-password
newPassword

(no description)

type
string
in
formData
204 No Content

Request was successful

Container

GET /Containers

200 OK

Request was successful

Response Example (200 OK)
[
  {}
]

POST /Containers

Request Example
"object"
200 OK

Request was successful

Response Example (200 OK)
"object"

DELETE /Containers/{container}

container

(no description)

type
string
in
path
200 OK

Request was successful

Response Example (200 OK)
{
  "undefined": "object"
}

GET /Containers/{container}

container

(no description)

type
string
in
path
200 OK

Request was successful

Response Example (200 OK)
"object"

GET /Containers/{container}/files

container

(no description)

type
string
in
path
200 OK

Request was successful

Response Example (200 OK)
[
  {}
]

GET /Containers/{container}/files/{file}

container

(no description)

type
string
in
path
file

(no description)

type
string
in
path
200 OK

Request was successful

Response Example (200 OK)
"object"

DELETE /Containers/{container}/files/{file}

container

(no description)

type
string
in
path
file

(no description)

type
string
in
path
200 OK

Request was successful

Response Example (200 OK)
{
  "undefined": "object"
}

POST /Containers/{container}/upload

200 OK

Request was successful

Response Example (200 OK)
{
  "result": "object"
}

GET /Containers/{container}/download/{file}

container

(no description)

type
string
in
path
file

(no description)

type
string
in
path
204 No Content

Request was successful

Attachment

Fetches belongsTo relation owner.

GET /Attachments/{id}/owner
refresh

(no description)

type
boolean
in
query
id

Attachment id

type
string (JSON)
in
path
200 OK

Request was successful

Response Example (200 OK)
{
  "firstName": "string",
  "lastName": "string",
  "fullName": "string",
  "initials": "string",
  "avatar": "string",
  "title": "string",
  "phone": "string",
  "location": "string",
  "roles": [
    "string"
  ],
  "defaultViews": "object",
  "alertSettings": "object",
  "deactivated": "boolean",
  "realm": "string",
  "username": "string",
  "email": "string",
  "emailVerified": "boolean",
  "id": "string",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)",
  "orgId": "string",
  "starredLinks": [
    {
      "name": "string",
      "starredOn": "string (date-time)",
      "id": "string",
      "starredItemId": "string",
      "starredItemType": "string"
    }
  ]
}

Create a new instance of the model and persist it into the data source.

POST /Attachments

Model instance data

Request Example
{
  "name": "string",
  "type": "string",
  "url": "string",
  "id": "string",
  "ownerId": "string",
  "appuserId": "string",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)"
}
200 OK

Request was successful

Response Example (200 OK)
{
  "name": "string",
  "type": "string",
  "url": "string",
  "id": "string",
  "ownerId": "string",
  "appuserId": "string",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)"
}

Patch an existing model instance or insert a new one into the data source.

PATCH /Attachments

Model instance data

Request Example
{
  "name": "string",
  "type": "string",
  "url": "string",
  "id": "string",
  "ownerId": "string",
  "appuserId": "string",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)"
}
200 OK

Request was successful

Response Example (200 OK)
{
  "name": "string",
  "type": "string",
  "url": "string",
  "id": "string",
  "ownerId": "string",
  "appuserId": "string",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)"
}

Replace an existing model instance or insert a new one into the data source.

PUT /Attachments

Model instance data

Request Example
{
  "name": "string",
  "type": "string",
  "url": "string",
  "id": "string",
  "ownerId": "string",
  "appuserId": "string",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)"
}
200 OK

Request was successful

Response Example (200 OK)
{
  "name": "string",
  "type": "string",
  "url": "string",
  "id": "string",
  "ownerId": "string",
  "appuserId": "string",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)"
}

Find all instances of the model matched by filter from the data source.

GET /Attachments
filter

Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ({"something":"value"})

type
string (JSON)
in
query
200 OK

Request was successful

Response Example (200 OK)
[
  {
    "name": "string",
    "type": "string",
    "url": "string",
    "id": "string",
    "ownerId": "string",
    "appuserId": "string",
    "createdOn": "string (date-time)",
    "updatedOn": "string (date-time)"
  }
]

Replace an existing model instance or insert a new one into the data source.

POST /Attachments/replaceOrCreate

Model instance data

Request Example
{
  "name": "string",
  "type": "string",
  "url": "string",
  "id": "string",
  "ownerId": "string",
  "appuserId": "string",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)"
}
200 OK

Request was successful

Response Example (200 OK)
{
  "name": "string",
  "type": "string",
  "url": "string",
  "id": "string",
  "ownerId": "string",
  "appuserId": "string",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)"
}

Update an existing model instance or insert a new one into the data source based on the where criteria.

POST /Attachments/upsertWithWhere

An object of model property name/value pairs

where

Criteria to match model instances

type
string (JSON)
in
query
Request Example
{
  "name": "string",
  "type": "string",
  "url": "string",
  "id": "string",
  "ownerId": "string",
  "appuserId": "string",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)"
}
200 OK

Request was successful

Response Example (200 OK)
{
  "name": "string",
  "type": "string",
  "url": "string",
  "id": "string",
  "ownerId": "string",
  "appuserId": "string",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)"
}

Check whether a model instance exists in the data source.

GET /Attachments/{id}/exists
id

Model id

type
string (JSON)
in
path
200 OK

Request was successful

Response Example (200 OK)
{
  "exists": "boolean"
}

Check whether a model instance exists in the data source.

HEAD /Attachments/{id}
id

Model id

type
string (JSON)
in
path
200 OK

Request was successful

Response Example (200 OK)
{
  "exists": "boolean"
}

Find a model instance by {{id}} from the data source.

GET /Attachments/{id}
id

Model id

type
string (JSON)
in
path
filter

Filter defining fields and include - must be a JSON-encoded string ({"something":"value"})

type
string (JSON)
in
query
200 OK

Request was successful

Response Example (200 OK)
{
  "name": "string",
  "type": "string",
  "url": "string",
  "id": "string",
  "ownerId": "string",
  "appuserId": "string",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)"
}

Replace attributes for a model instance and persist it into the data source.

PUT /Attachments/{id}

Model instance data

id

Model id

type
string (JSON)
in
path
Request Example
{
  "name": "string",
  "type": "string",
  "url": "string",
  "id": "string",
  "ownerId": "string",
  "appuserId": "string",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)"
}
200 OK

Request was successful

Response Example (200 OK)
{
  "name": "string",
  "type": "string",
  "url": "string",
  "id": "string",
  "ownerId": "string",
  "appuserId": "string",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)"
}

Delete a model instance by {{id}} from the data source.

DELETE /Attachments/{id}
id

Model id

type
string (JSON)
in
path
200 OK

Request was successful

Response Example (200 OK)
"object"

Patch attributes for a model instance and persist it into the data source.

PATCH /Attachments/{id}

An object of model property name/value pairs

id

Attachment id

type
string (JSON)
in
path
Request Example
{
  "name": "string",
  "type": "string",
  "url": "string",
  "id": "string",
  "ownerId": "string",
  "appuserId": "string",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)"
}
200 OK

Request was successful

Response Example (200 OK)
{
  "name": "string",
  "type": "string",
  "url": "string",
  "id": "string",
  "ownerId": "string",
  "appuserId": "string",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)"
}

Replace attributes for a model instance and persist it into the data source.

POST /Attachments/{id}/replace

Model instance data

id

Model id

type
string (JSON)
in
path
Request Example
{
  "name": "string",
  "type": "string",
  "url": "string",
  "id": "string",
  "ownerId": "string",
  "appuserId": "string",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)"
}
200 OK

Request was successful

Response Example (200 OK)
{
  "name": "string",
  "type": "string",
  "url": "string",
  "id": "string",
  "ownerId": "string",
  "appuserId": "string",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)"
}

Find first instance of the model matched by filter from the data source.

GET /Attachments/findOne
filter

Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ({"something":"value"})

type
string (JSON)
in
query
200 OK

Request was successful

Response Example (200 OK)
{
  "name": "string",
  "type": "string",
  "url": "string",
  "id": "string",
  "ownerId": "string",
  "appuserId": "string",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)"
}

Update instances of the model matched by {{where}} from the data source.

POST /Attachments/update

An object of model property name/value pairs

where

Criteria to match model instances

type
string (JSON)
in
query
Request Example
{
  "name": "string",
  "type": "string",
  "url": "string",
  "id": "string",
  "ownerId": "string",
  "appuserId": "string",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)"
}
200 OK

Request was successful

Response Example (200 OK)
{
  "count": "number (double)"
}

Count instances of the model matched by where from the data source.

GET /Attachments/count
where

Criteria to match model instances

type
string (JSON)
in
query
200 OK

Request was successful

Response Example (200 OK)
{
  "count": "number (double)"
}

Create a change stream.

POST /Attachments/change-stream
options

(no description)

type
string (JSON)
in
formData
200 OK

Request was successful

Response Example (200 OK)
"file"

Create a change stream.

GET /Attachments/change-stream
options

(no description)

type
string (JSON)
in
query
200 OK

Request was successful

Response Example (200 OK)
"file"

Uploads a file

POST /Attachments/upload
options

(no description)

type
string (JSON)
in
query
200 OK

Request was successful

Response Example (200 OK)
"object"

Team

Find a related item by id for members.

GET /Teams/{id}/members/{fk}
fk

Foreign key for members

type
string (JSON)
in
path
id

Team id

type
string (JSON)
in
path
200 OK

Request was successful

Response Example (200 OK)
{
  "firstName": "string",
  "lastName": "string",
  "fullName": "string",
  "initials": "string",
  "avatar": "string",
  "title": "string",
  "phone": "string",
  "location": "string",
  "roles": [
    "string"
  ],
  "defaultViews": "object",
  "alertSettings": "object",
  "deactivated": "boolean",
  "realm": "string",
  "username": "string",
  "email": "string",
  "emailVerified": "boolean",
  "id": "string",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)",
  "orgId": "string",
  "starredLinks": [
    {
      "name": "string",
      "starredOn": "string (date-time)",
      "id": "string",
      "starredItemId": "string",
      "starredItemType": "string"
    }
  ]
}

Delete a related item by id for members.

DELETE /Teams/{id}/members/{fk}
fk

Foreign key for members

type
string (JSON)
in
path
id

Team id

type
string (JSON)
in
path
204 No Content

Request was successful

Update a related item by id for members.

PUT /Teams/{id}/members/{fk}
undefined
fk

Foreign key for members

type
string (JSON)
in
path
id

Team id

type
string (JSON)
in
path
Request Example
{
  "firstName": "string",
  "lastName": "string",
  "fullName": "string",
  "initials": "string",
  "avatar": "string",
  "title": "string",
  "phone": "string",
  "location": "string",
  "roles": [
    "string"
  ],
  "defaultViews": "object",
  "alertSettings": "object",
  "deactivated": "boolean",
  "realm": "string",
  "username": "string",
  "email": "string",
  "emailVerified": "boolean",
  "id": "string",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)",
  "orgId": "string",
  "starredLinks": [
    {
      "name": "string",
      "starredOn": "string (date-time)",
      "id": "string",
      "starredItemId": "string",
      "starredItemType": "string"
    }
  ]
}
200 OK

Request was successful

Response Example (200 OK)
{
  "firstName": "string",
  "lastName": "string",
  "fullName": "string",
  "initials": "string",
  "avatar": "string",
  "title": "string",
  "phone": "string",
  "location": "string",
  "roles": [
    "string"
  ],
  "defaultViews": "object",
  "alertSettings": "object",
  "deactivated": "boolean",
  "realm": "string",
  "username": "string",
  "email": "string",
  "emailVerified": "boolean",
  "id": "string",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)",
  "orgId": "string",
  "starredLinks": [
    {
      "name": "string",
      "starredOn": "string (date-time)",
      "id": "string",
      "starredItemId": "string",
      "starredItemType": "string"
    }
  ]
}

Add a related item by id for members.

PUT /Teams/{id}/members/rel/{fk}
undefined
fk

Foreign key for members

type
string (JSON)
in
path
id

Team id

type
string (JSON)
in
path
Request Example
{
  "id": "string",
  "teamId": "string",
  "appuserId": "string"
}
200 OK

Request was successful

Response Example (200 OK)
{
  "id": "string",
  "teamId": "string",
  "appuserId": "string"
}

Remove the members relation to an item by id.

DELETE /Teams/{id}/members/rel/{fk}
fk

Foreign key for members

type
string (JSON)
in
path
id

Team id

type
string (JSON)
in
path
204 No Content

Request was successful

Check the existence of members relation to an item by id.

HEAD /Teams/{id}/members/rel/{fk}
fk

Foreign key for members

type
string (JSON)
in
path
id

Team id

type
string (JSON)
in
path
200 OK

Request was successful

Response Example (200 OK)
"boolean"

Queries members of Team.

GET /Teams/{id}/members
filter

(no description)

type
string (JSON)
in
query
id

Team id

type
string (JSON)
in
path
200 OK

Request was successful

Response Example (200 OK)
[
  {
    "firstName": "string",
    "lastName": "string",
    "fullName": "string",
    "initials": "string",
    "avatar": "string",
    "title": "string",
    "phone": "string",
    "location": "string",
    "roles": [
      "string"
    ],
    "defaultViews": "object",
    "alertSettings": "object",
    "deactivated": "boolean",
    "realm": "string",
    "username": "string",
    "email": "string",
    "emailVerified": "boolean",
    "id": "string",
    "createdOn": "string (date-time)",
    "updatedOn": "string (date-time)",
    "orgId": "string",
    "starredLinks": [
      {
        "name": "string",
        "starredOn": "string (date-time)",
        "id": "string",
        "starredItemId": "string",
        "starredItemType": "string"
      }
    ]
  }
]

Creates a new instance in members of this model.

POST /Teams/{id}/members
undefined
id

Team id

type
string (JSON)
in
path
Request Example
{
  "firstName": "string",
  "lastName": "string",
  "fullName": "string",
  "initials": "string",
  "avatar": "string",
  "title": "string",
  "phone": "string",
  "location": "string",
  "roles": [
    "string"
  ],
  "defaultViews": "object",
  "alertSettings": "object",
  "deactivated": "boolean",
  "realm": "string",
  "username": "string",
  "email": "string",
  "emailVerified": "boolean",
  "id": "string",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)",
  "orgId": "string",
  "starredLinks": [
    {
      "name": "string",
      "starredOn": "string (date-time)",
      "id": "string",
      "starredItemId": "string",
      "starredItemType": "string"
    }
  ]
}
200 OK

Request was successful

Response Example (200 OK)
{
  "firstName": "string",
  "lastName": "string",
  "fullName": "string",
  "initials": "string",
  "avatar": "string",
  "title": "string",
  "phone": "string",
  "location": "string",
  "roles": [
    "string"
  ],
  "defaultViews": "object",
  "alertSettings": "object",
  "deactivated": "boolean",
  "realm": "string",
  "username": "string",
  "email": "string",
  "emailVerified": "boolean",
  "id": "string",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)",
  "orgId": "string",
  "starredLinks": [
    {
      "name": "string",
      "starredOn": "string (date-time)",
      "id": "string",
      "starredItemId": "string",
      "starredItemType": "string"
    }
  ]
}

Deletes all members of this model.

DELETE /Teams/{id}/members
id

Team id

type
string (JSON)
in
path
204 No Content

Request was successful

Counts members of Team.

GET /Teams/{id}/members/count
where

Criteria to match model instances

type
string (JSON)
in
query
id

Team id

type
string (JSON)
in
path
200 OK

Request was successful

Response Example (200 OK)
{
  "count": "number (double)"
}

Create a new instance of the model and persist it into the data source.

POST /Teams

Model instance data

Request Example
{
  "name": "string",
  "ownerId": "string",
  "id": "string",
  "deletedAt": "string (date-time)",
  "_isDeleted": "boolean",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)"
}
200 OK

Request was successful

Response Example (200 OK)
{
  "name": "string",
  "ownerId": "string",
  "id": "string",
  "deletedAt": "string (date-time)",
  "_isDeleted": "boolean",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)"
}

Patch an existing model instance or insert a new one into the data source.

PATCH /Teams

Model instance data

Request Example
{
  "name": "string",
  "ownerId": "string",
  "id": "string",
  "deletedAt": "string (date-time)",
  "_isDeleted": "boolean",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)"
}
200 OK

Request was successful

Response Example (200 OK)
{
  "name": "string",
  "ownerId": "string",
  "id": "string",
  "deletedAt": "string (date-time)",
  "_isDeleted": "boolean",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)"
}

Replace an existing model instance or insert a new one into the data source.

PUT /Teams

Model instance data

Request Example
{
  "name": "string",
  "ownerId": "string",
  "id": "string",
  "deletedAt": "string (date-time)",
  "_isDeleted": "boolean",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)"
}
200 OK

Request was successful

Response Example (200 OK)
{
  "name": "string",
  "ownerId": "string",
  "id": "string",
  "deletedAt": "string (date-time)",
  "_isDeleted": "boolean",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)"
}

Find all instances of the model matched by filter from the data source.

GET /Teams
filter

Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ({"something":"value"})

type
string (JSON)
in
query
200 OK

Request was successful

Response Example (200 OK)
[
  {
    "name": "string",
    "ownerId": "string",
    "id": "string",
    "deletedAt": "string (date-time)",
    "_isDeleted": "boolean",
    "createdOn": "string (date-time)",
    "updatedOn": "string (date-time)"
  }
]

Replace an existing model instance or insert a new one into the data source.

POST /Teams/replaceOrCreate

Model instance data

Request Example
{
  "name": "string",
  "ownerId": "string",
  "id": "string",
  "deletedAt": "string (date-time)",
  "_isDeleted": "boolean",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)"
}
200 OK

Request was successful

Response Example (200 OK)
{
  "name": "string",
  "ownerId": "string",
  "id": "string",
  "deletedAt": "string (date-time)",
  "_isDeleted": "boolean",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)"
}

Update an existing model instance or insert a new one into the data source based on the where criteria.

POST /Teams/upsertWithWhere

An object of model property name/value pairs

where

Criteria to match model instances

type
string (JSON)
in
query
Request Example
{
  "name": "string",
  "ownerId": "string",
  "id": "string",
  "deletedAt": "string (date-time)",
  "_isDeleted": "boolean",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)"
}
200 OK

Request was successful

Response Example (200 OK)
{
  "name": "string",
  "ownerId": "string",
  "id": "string",
  "deletedAt": "string (date-time)",
  "_isDeleted": "boolean",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)"
}

Check whether a model instance exists in the data source.

GET /Teams/{id}/exists
id

Model id

type
string (JSON)
in
path
200 OK

Request was successful

Response Example (200 OK)
{
  "exists": "boolean"
}

Check whether a model instance exists in the data source.

HEAD /Teams/{id}
id

Model id

type
string (JSON)
in
path
200 OK

Request was successful

Response Example (200 OK)
{
  "exists": "boolean"
}

Find a model instance by {{id}} from the data source.

GET /Teams/{id}
id

Model id

type
string (JSON)
in
path
filter

Filter defining fields and include - must be a JSON-encoded string ({"something":"value"})

type
string (JSON)
in
query
200 OK

Request was successful

Response Example (200 OK)
{
  "name": "string",
  "ownerId": "string",
  "id": "string",
  "deletedAt": "string (date-time)",
  "_isDeleted": "boolean",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)"
}

Replace attributes for a model instance and persist it into the data source.

PUT /Teams/{id}

Model instance data

id

Model id

type
string (JSON)
in
path
Request Example
{
  "name": "string",
  "ownerId": "string",
  "id": "string",
  "deletedAt": "string (date-time)",
  "_isDeleted": "boolean",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)"
}
200 OK

Request was successful

Response Example (200 OK)
{
  "name": "string",
  "ownerId": "string",
  "id": "string",
  "deletedAt": "string (date-time)",
  "_isDeleted": "boolean",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)"
}

Delete a model instance by {{id}} from the data source.

DELETE /Teams/{id}
id

Model id

type
string (JSON)
in
path
200 OK

Request was successful

Response Example (200 OK)
"object"

Patch attributes for a model instance and persist it into the data source.

PATCH /Teams/{id}

An object of model property name/value pairs

id

Team id

type
string (JSON)
in
path
Request Example
{
  "name": "string",
  "ownerId": "string",
  "id": "string",
  "deletedAt": "string (date-time)",
  "_isDeleted": "boolean",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)"
}
200 OK

Request was successful

Response Example (200 OK)
{
  "name": "string",
  "ownerId": "string",
  "id": "string",
  "deletedAt": "string (date-time)",
  "_isDeleted": "boolean",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)"
}

Replace attributes for a model instance and persist it into the data source.

POST /Teams/{id}/replace

Model instance data

id

Model id

type
string (JSON)
in
path
Request Example
{
  "name": "string",
  "ownerId": "string",
  "id": "string",
  "deletedAt": "string (date-time)",
  "_isDeleted": "boolean",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)"
}
200 OK

Request was successful

Response Example (200 OK)
{
  "name": "string",
  "ownerId": "string",
  "id": "string",
  "deletedAt": "string (date-time)",
  "_isDeleted": "boolean",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)"
}

Find first instance of the model matched by filter from the data source.

GET /Teams/findOne
filter

Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ({"something":"value"})

type
string (JSON)
in
query
200 OK

Request was successful

Response Example (200 OK)
{
  "name": "string",
  "ownerId": "string",
  "id": "string",
  "deletedAt": "string (date-time)",
  "_isDeleted": "boolean",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)"
}

Update instances of the model matched by {{where}} from the data source.

POST /Teams/update

An object of model property name/value pairs

where

Criteria to match model instances

type
string (JSON)
in
query
Request Example
{
  "name": "string",
  "ownerId": "string",
  "id": "string",
  "deletedAt": "string (date-time)",
  "_isDeleted": "boolean",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)"
}
200 OK

Request was successful

Response Example (200 OK)
{
  "count": "number (double)"
}

Count instances of the model matched by where from the data source.

GET /Teams/count
where

Criteria to match model instances

type
string (JSON)
in
query
200 OK

Request was successful

Response Example (200 OK)
{
  "count": "number (double)"
}

Create a change stream.

POST /Teams/change-stream
options

(no description)

type
string (JSON)
in
formData
200 OK

Request was successful

Response Example (200 OK)
"file"

Create a change stream.

GET /Teams/change-stream
options

(no description)

type
string (JSON)
in
query
200 OK

Request was successful

Response Example (200 OK)
"file"

Org

Org

Fetches hasOne relation owner.

GET /Orgs/{id}/owner
refresh

(no description)

type
boolean
in
query
id

Org id

type
string (JSON)
in
path
200 OK

Request was successful

Response Example (200 OK)
{
  "firstName": "string",
  "lastName": "string",
  "fullName": "string",
  "initials": "string",
  "avatar": "string",
  "title": "string",
  "phone": "string",
  "location": "string",
  "roles": [
    "string"
  ],
  "defaultViews": "object",
  "alertSettings": "object",
  "deactivated": "boolean",
  "realm": "string",
  "username": "string",
  "email": "string",
  "emailVerified": "boolean",
  "id": "string",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)",
  "orgId": "string",
  "starredLinks": [
    {
      "name": "string",
      "starredOn": "string (date-time)",
      "id": "string",
      "starredItemId": "string",
      "starredItemType": "string"
    }
  ]
}
Org

Creates a new instance in owner of this model.

POST /Orgs/{id}/owner
undefined
id

Org id

type
string (JSON)
in
path
Request Example
{
  "firstName": "string",
  "lastName": "string",
  "fullName": "string",
  "initials": "string",
  "avatar": "string",
  "title": "string",
  "phone": "string",
  "location": "string",
  "roles": [
    "string"
  ],
  "defaultViews": "object",
  "alertSettings": "object",
  "deactivated": "boolean",
  "realm": "string",
  "username": "string",
  "email": "string",
  "emailVerified": "boolean",
  "id": "string",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)",
  "orgId": "string",
  "starredLinks": [
    {
      "name": "string",
      "starredOn": "string (date-time)",
      "id": "string",
      "starredItemId": "string",
      "starredItemType": "string"
    }
  ]
}
200 OK

Request was successful

Response Example (200 OK)
{
  "firstName": "string",
  "lastName": "string",
  "fullName": "string",
  "initials": "string",
  "avatar": "string",
  "title": "string",
  "phone": "string",
  "location": "string",
  "roles": [
    "string"
  ],
  "defaultViews": "object",
  "alertSettings": "object",
  "deactivated": "boolean",
  "realm": "string",
  "username": "string",
  "email": "string",
  "emailVerified": "boolean",
  "id": "string",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)",
  "orgId": "string",
  "starredLinks": [
    {
      "name": "string",
      "starredOn": "string (date-time)",
      "id": "string",
      "starredItemId": "string",
      "starredItemType": "string"
    }
  ]
}
Org

Update owner of this model.

PUT /Orgs/{id}/owner
undefined
id

Org id

type
string (JSON)
in
path
Request Example
{
  "firstName": "string",
  "lastName": "string",
  "fullName": "string",
  "initials": "string",
  "avatar": "string",
  "title": "string",
  "phone": "string",
  "location": "string",
  "roles": [
    "string"
  ],
  "defaultViews": "object",
  "alertSettings": "object",
  "deactivated": "boolean",
  "realm": "string",
  "username": "string",
  "email": "string",
  "emailVerified": "boolean",
  "id": "string",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)",
  "orgId": "string",
  "starredLinks": [
    {
      "name": "string",
      "starredOn": "string (date-time)",
      "id": "string",
      "starredItemId": "string",
      "starredItemType": "string"
    }
  ]
}
200 OK

Request was successful

Response Example (200 OK)
{
  "firstName": "string",
  "lastName": "string",
  "fullName": "string",
  "initials": "string",
  "avatar": "string",
  "title": "string",
  "phone": "string",
  "location": "string",
  "roles": [
    "string"
  ],
  "defaultViews": "object",
  "alertSettings": "object",
  "deactivated": "boolean",
  "realm": "string",
  "username": "string",
  "email": "string",
  "emailVerified": "boolean",
  "id": "string",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)",
  "orgId": "string",
  "starredLinks": [
    {
      "name": "string",
      "starredOn": "string (date-time)",
      "id": "string",
      "starredItemId": "string",
      "starredItemType": "string"
    }
  ]
}
Org

Deletes owner of this model.

DELETE /Orgs/{id}/owner
id

Org id

type
string (JSON)
in
path
204 No Content

Request was successful

Org

Find a related item by id for forecastCategories.

GET /Orgs/{id}/forecastCategories/{fk}
fk

Foreign key for forecastCategories

type
string (JSON)
in
path
id

Org id

type
string (JSON)
in
path

Request was successful

Response Example (200 OK)
{
  "label": "string",
  "value": "string",
  "icon": "string",
  "id": "string",
  "organizationId": "string",
  "orgId": "string",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)"
}
Org

Delete a related item by id for forecastCategories.

DELETE /Orgs/{id}/forecastCategories/{fk}
fk

Foreign key for forecastCategories

type
string (JSON)
in
path
id

Org id

type
string (JSON)
in
path
204 No Content

Request was successful

Org

Update a related item by id for forecastCategories.

PUT /Orgs/{id}/forecastCategories/{fk}
undefined
fk

Foreign key for forecastCategories

type
string (JSON)
in
path
id

Org id

type
string (JSON)
in
path
Request Example
{
  "label": "string",
  "value": "string",
  "icon": "string",
  "id": "string",
  "organizationId": "string",
  "orgId": "string",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)"
}

Request was successful

Response Example (200 OK)
{
  "label": "string",
  "value": "string",
  "icon": "string",
  "id": "string",
  "organizationId": "string",
  "orgId": "string",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)"
}
Org

Find a related item by id for opportunityStatuses.

GET /Orgs/{id}/opportunityStatuses/{fk}
fk

Foreign key for opportunityStatuses

type
string (JSON)
in
path
id

Org id

type
string (JSON)
in
path

Request was successful

Response Example (200 OK)
{
  "label": "string",
  "value": "string",
  "color": "string",
  "id": "string",
  "organizationId": "string",
  "orgId": "string"
}
Org

Delete a related item by id for opportunityStatuses.

DELETE /Orgs/{id}/opportunityStatuses/{fk}
fk

Foreign key for opportunityStatuses

type
string (JSON)
in
path
id

Org id

type
string (JSON)
in
path
204 No Content

Request was successful

Org

Update a related item by id for opportunityStatuses.

PUT /Orgs/{id}/opportunityStatuses/{fk}
undefined
fk

Foreign key for opportunityStatuses

type
string (JSON)
in
path
id

Org id

type
string (JSON)
in
path
Request Example
{
  "label": "string",
  "value": "string",
  "color": "string",
  "id": "string",
  "organizationId": "string",
  "orgId": "string"
}

Request was successful

Response Example (200 OK)
{
  "label": "string",
  "value": "string",
  "color": "string",
  "id": "string",
  "organizationId": "string",
  "orgId": "string"
}
Org

Find a related item by id for featureFlags.

GET /Orgs/{id}/featureFlags/{fk}
fk

Foreign key for featureFlags

type
string (JSON)
in
path
id

Org id

type
string (JSON)
in
path
200 OK

Request was successful

Response Example (200 OK)
{
  "key": "string",
  "name": "string",
  "active": "boolean",
  "group": "string",
  "id": "string",
  "orgsId": "string",
  "orgId": "string"
}
Org

Delete a related item by id for featureFlags.

DELETE /Orgs/{id}/featureFlags/{fk}
fk

Foreign key for featureFlags

type
string (JSON)
in
path
id

Org id

type
string (JSON)
in
path
204 No Content

Request was successful

Org

Update a related item by id for featureFlags.

PUT /Orgs/{id}/featureFlags/{fk}
undefined
fk

Foreign key for featureFlags

type
string (JSON)
in
path
id

Org id

type
string (JSON)
in
path
Request Example
{
  "key": "string",
  "name": "string",
  "active": "boolean",
  "group": "string",
  "id": "string",
  "orgsId": "string",
  "orgId": "string"
}
200 OK

Request was successful

Response Example (200 OK)
{
  "key": "string",
  "name": "string",
  "active": "boolean",
  "group": "string",
  "id": "string",
  "orgsId": "string",
  "orgId": "string"
}
Org

Queries forecastCategories of Org.

GET /Orgs/{id}/forecastCategories
filter

(no description)

type
string (JSON)
in
query
id

Org id

type
string (JSON)
in
path

Request was successful

Response Example (200 OK)
[
  {
    "label": "string",
    "value": "string",
    "icon": "string",
    "id": "string",
    "organizationId": "string",
    "orgId": "string",
    "createdOn": "string (date-time)",
    "updatedOn": "string (date-time)"
  }
]
Org

Creates a new instance in forecastCategories of this model.

POST /Orgs/{id}/forecastCategories
undefined
id

Org id

type
string (JSON)
in
path
Request Example
{
  "label": "string",
  "value": "string",
  "icon": "string",
  "id": "string",
  "organizationId": "string",
  "orgId": "string",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)"
}

Request was successful

Response Example (200 OK)
{
  "label": "string",
  "value": "string",
  "icon": "string",
  "id": "string",
  "organizationId": "string",
  "orgId": "string",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)"
}
Org

Deletes all forecastCategories of this model.

DELETE /Orgs/{id}/forecastCategories
id

Org id

type
string (JSON)
in
path
204 No Content

Request was successful

Org

Counts forecastCategories of Org.

GET /Orgs/{id}/forecastCategories/count
where

Criteria to match model instances

type
string (JSON)
in
query
id

Org id

type
string (JSON)
in
path
200 OK

Request was successful

Response Example (200 OK)
{
  "count": "number (double)"
}
Org

Queries opportunityStatuses of Org.

GET /Orgs/{id}/opportunityStatuses
filter

(no description)

type
string (JSON)
in
query
id

Org id

type
string (JSON)
in
path

Request was successful

Response Example (200 OK)
[
  {
    "label": "string",
    "value": "string",
    "color": "string",
    "id": "string",
    "organizationId": "string",
    "orgId": "string"
  }
]
Org

Creates a new instance in opportunityStatuses of this model.

POST /Orgs/{id}/opportunityStatuses
undefined
id

Org id

type
string (JSON)
in
path
Request Example
{
  "label": "string",
  "value": "string",
  "color": "string",
  "id": "string",
  "organizationId": "string",
  "orgId": "string"
}

Request was successful

Response Example (200 OK)
{
  "label": "string",
  "value": "string",
  "color": "string",
  "id": "string",
  "organizationId": "string",
  "orgId": "string"
}
Org

Deletes all opportunityStatuses of this model.

DELETE /Orgs/{id}/opportunityStatuses
id

Org id

type
string (JSON)
in
path
204 No Content

Request was successful

Org

Counts opportunityStatuses of Org.

GET /Orgs/{id}/opportunityStatuses/count
where

Criteria to match model instances

type
string (JSON)
in
query
id

Org id

type
string (JSON)
in
path
200 OK

Request was successful

Response Example (200 OK)
{
  "count": "number (double)"
}
Org

Queries featureFlags of Org.

GET /Orgs/{id}/featureFlags
filter

(no description)

type
string (JSON)
in
query
id

Org id

type
string (JSON)
in
path
200 OK

Request was successful

Response Example (200 OK)
[
  {
    "key": "string",
    "name": "string",
    "active": "boolean",
    "group": "string",
    "id": "string",
    "orgsId": "string",
    "orgId": "string"
  }
]
Org

Creates a new instance in featureFlags of this model.

POST /Orgs/{id}/featureFlags
undefined
id

Org id

type
string (JSON)
in
path
Request Example
{
  "key": "string",
  "name": "string",
  "active": "boolean",
  "group": "string",
  "id": "string",
  "orgsId": "string",
  "orgId": "string"
}
200 OK

Request was successful

Response Example (200 OK)
{
  "key": "string",
  "name": "string",
  "active": "boolean",
  "group": "string",
  "id": "string",
  "orgsId": "string",
  "orgId": "string"
}
Org

Deletes all featureFlags of this model.

DELETE /Orgs/{id}/featureFlags
id

Org id

type
string (JSON)
in
path
204 No Content

Request was successful

Org

Counts featureFlags of Org.

GET /Orgs/{id}/featureFlags/count
where

Criteria to match model instances

type
string (JSON)
in
query
id

Org id

type
string (JSON)
in
path
200 OK

Request was successful

Response Example (200 OK)
{
  "count": "number (double)"
}
Org

Create a new instance of the model and persist it into the data source.

POST /Orgs
Org

Model instance data

Request Example
{
  "name": "string",
  "url": "string",
  "config": "object",
  "entities": "object",
  "billing": "object",
  "id": "string",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)"
}
200 OK
Org

Request was successful

Response Example (200 OK)
{
  "name": "string",
  "url": "string",
  "config": "object",
  "entities": "object",
  "billing": "object",
  "id": "string",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)"
}
Org

Patch an existing model instance or insert a new one into the data source.

PATCH /Orgs
Org

Model instance data

Request Example
{
  "name": "string",
  "url": "string",
  "config": "object",
  "entities": "object",
  "billing": "object",
  "id": "string",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)"
}
200 OK
Org

Request was successful

Response Example (200 OK)
{
  "name": "string",
  "url": "string",
  "config": "object",
  "entities": "object",
  "billing": "object",
  "id": "string",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)"
}
Org

Replace an existing model instance or insert a new one into the data source.

PUT /Orgs
Org

Model instance data

Request Example
{
  "name": "string",
  "url": "string",
  "config": "object",
  "entities": "object",
  "billing": "object",
  "id": "string",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)"
}
200 OK
Org

Request was successful

Response Example (200 OK)
{
  "name": "string",
  "url": "string",
  "config": "object",
  "entities": "object",
  "billing": "object",
  "id": "string",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)"
}
Org

Find all instances of the model matched by filter from the data source.

GET /Orgs
filter

Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ({"something":"value"})

type
string (JSON)
in
query
200 OK
Org

Request was successful

Response Example (200 OK)
[
  {
    "name": "string",
    "url": "string",
    "config": "object",
    "entities": "object",
    "billing": "object",
    "id": "string",
    "createdOn": "string (date-time)",
    "updatedOn": "string (date-time)"
  }
]
Org

Replace an existing model instance or insert a new one into the data source.

POST /Orgs/replaceOrCreate
Org

Model instance data

Request Example
{
  "name": "string",
  "url": "string",
  "config": "object",
  "entities": "object",
  "billing": "object",
  "id": "string",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)"
}
200 OK
Org

Request was successful

Response Example (200 OK)
{
  "name": "string",
  "url": "string",
  "config": "object",
  "entities": "object",
  "billing": "object",
  "id": "string",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)"
}
Org

Update an existing model instance or insert a new one into the data source based on the where criteria.

POST /Orgs/upsertWithWhere
Org

An object of model property name/value pairs

where

Criteria to match model instances

type
string (JSON)
in
query
Request Example
{
  "name": "string",
  "url": "string",
  "config": "object",
  "entities": "object",
  "billing": "object",
  "id": "string",
  "createdOn": "string (date-time)",
  "updatedOn": "string (date-time)"
}
200 OK