DIM

All DIMS

get

https://api.example.comhttps://staging-api.example.com

/api/v1/dim/

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successful response

application/json

get

/api/v1/dim/

HTTPcURLJavaScriptPython

GET /api/v1/dim/ HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

No content

Single DIM

get

https://api.example.comhttps://staging-api.example.com

/api/v1/dim/{dimId}

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

dimIdintegerRequiredExample: 1

Responses

200

Successful response

application/json

get

/api/v1/dim/{dimId}

HTTPcURLJavaScriptPython

GET /api/v1/dim/{dimId} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

No content

Edit DIM

put

https://api.example.comhttps://staging-api.example.com

/api/v1/dim/{dimId}

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

dimIdintegerRequiredExample: 1

Body

application/json

objectOptionalExample: {"name":"Testing DIM","scopeId":1,"type":"test","description":"Test description","context":"Test context","expressions":["sample expression one","sample expression two"],"responses":["sample response one","sample response two"]}

Responses

200

Successful response

application/json

put

/api/v1/dim/{dimId}

HTTPcURLJavaScriptPython

PUT /api/v1/dim/{dimId} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 228

{
  "name": "Testing DIM",
  "scopeId": 1,
  "type": "test",
  "description": "Test description",
  "context": "Test context",
  "expressions": [
    "sample expression one",
    "sample expression two"
  ],
  "responses": [
    "sample response one",
    "sample response two"
  ]
}

200

Successful response

No content

Create DIM

post

https://api.example.comhttps://staging-api.example.com

/api/v1/dim

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

objectOptionalExample: {"name":"Demo DIM","scopes":[18],"type":"demo"}

Responses

200

Successful response

application/json

post

/api/v1/dim

HTTPcURLJavaScriptPython

POST /api/v1/dim HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "name": "Demo DIM",
  "scopes": [
    18
  ],
  "type": "demo"
}

200

Successful response

No content

Delete DIM

delete

https://api.example.comhttps://staging-api.example.com

/api/v1/dim/{dimId}/delete

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

dimIdintegerRequiredExample: 1

Responses

200

Successful response

application/json

delete

/api/v1/dim/{dimId}/delete

HTTPcURLJavaScriptPython

DELETE /api/v1/dim/{dimId}/delete HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

No content

Toggle debug

patch

https://api.example.comhttps://staging-api.example.com

/api/v1/dim/{dimId}/toggle

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

dimIdintegerRequiredExample: 3

Body

Responses

200

Successful response

application/json

patch

/api/v1/dim/{dimId}/toggle

HTTPcURLJavaScriptPython

PATCH /api/v1/dim/{dimId}/toggle HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

No content

Verify Dim Token

get

https://api.example.comhttps://staging-api.example.com

/api/v1/dim/verify/token/{token}

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

tokenstringRequiredExample: abc123def456ghi789jkl012mno345pqr678stu901vwx234yz567

Responses

200

Successful response

application/json

get

/api/v1/dim/verify/token/{token}

HTTPcURLJavaScriptPython

GET /api/v1/dim/verify/token/{token} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

No content

Update Expression and Intent Number by UUID

patch

https://api.example.comhttps://staging-api.example.com

/api/v1/dim/{uuid}

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

uuidstringRequiredExample: 12345678-1234-1234-1234-123456789abc

Body

application/json

objectOptionalExample: {"expressionNumber":2,"intentNumber":2}

Responses

200

Successful response

application/json

patch

/api/v1/dim/{uuid}

HTTPcURLJavaScriptPython

PATCH /api/v1/dim/{uuid} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 39

{
  "expressionNumber": 2,
  "intentNumber": 2
}

200

Successful response

No content

Create DIM From Presentation

post

https://api.example.comhttps://staging-api.example.com

/api/v1/dim/presentation

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

objectOptionalExample: {"name":"Test DIM","scopes":["identity"],"type":"test","expressions":[],"responses":[]}

Responses

200

Successful response

application/json

post

/api/v1/dim/presentation

HTTPcURLJavaScriptPython

POST /api/v1/dim/presentation HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 87

{
  "name": "Test DIM",
  "scopes": [
    "identity"
  ],
  "type": "test",
  "expressions": [],
  "responses": []
}

200

Successful response

No content