Skip to main content
API docs by Redocly

Categorization API (v2)

Download OpenAPI specification:Download

URL: https://api.enablenow.nl

categorization-jobs

GET categorization-jobs

Authorizations:
bearer
query Parameters
ConsentId
string or null <guid>
UserId
string or null <guid>
ExternalUserId
string or null
AccountId
string or null <guid>
Page
integer or null <int32>
PageSize
integer or null <int32>

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "_pagination": {
    }
}

POST categorization-job

Authorizations:
bearer
Request Body schema: application/json
required
engine
string

The engine used for categorization

profile
string

The engine-profile used for categorization

consentId
string or null <guid>

The consent identifier for which to retrieve the categorization jobs

userId
string or null <guid>

The user identifier for which to retrieve the categorization jobs

externalUserId
string or null

The external user identifier for which to retrieve the categorization jobs

accountIds
Array of strings or null <guid> [ items <guid > ]

The account ids used for categorization

object or null

Dynamic metadata used for categorization-jobs
Use the EnableNow documentation site to determine which metadata is required for each engine/ profile.

Responses

Request samples

Content type
application/json
{
  • "engine": "string",
  • "profile": "string",
  • "consentId": "string",
  • "userId": "string",
  • "externalUserId": "string",
  • "accountIds": [
    ],
  • "metaData": {
    }
}

Response samples

Content type
application/json
{
  • "data": "string"
}

GET categorization-job by id

Authorizations:
bearer
path Parameters
id
required
string <guid>

The categorization-job identifier

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

LIST categorization-jobs

Authorizations:
bearer
query Parameters
AppId
integer or null <int32>
(CategorizationJobStatus2 (integer or null))
Filter
string or null
Page
integer or null <int32>
PageSize
integer or null <int32>

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "_pagination": {
    }
}

DETAILS categorization-job by id

Authorizations:
bearer
path Parameters
id
required
string <guid>

The categorization-job identifier

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

BULK-DELETE categorization-job

Authorizations:
bearer
Request Body schema: application/json
required
ids
required
Array of strings <guid> [ items <guid > ]

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "data": "string"
}