Evaluation API: Questions

Retrieves one specific bank

get

Authorizations

BearerCookie

BearerstringRequired

Path parameters

bankstring · uuidRequired

Responses

200

OK

application/jsontext/json

get

/api/evaluation/banks/{bank}

HTTPcURLJavaScriptPython

GET /v2/e01/api/evaluation/banks/{bank} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

{
  "bankIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "departmentIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "frameworkIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "isActive": true,
  "bankEdition": "text",
  "bankLevel": "text",
  "bankName": "text",
  "bankStatus": "text",
  "bankTitle": "text",
  "bankType": "text",
  "lastChangeType": "text",
  "lastChangeUser": "text",
  "assetNumber": 1,
  "attachmentCount": 1,
  "bankSize": 1,
  "commentCount": 1,
  "formCount": 1,
  "optionCount": 1,
  "questionCount": 1,
  "setCount": 1,
  "specCount": 1,
  "lastChangeTime": "2026-01-22T14:51:43.318Z"
}

Checks for the existence of one specific bank

head

Authorizations

BearerCookie

BearerstringRequired

Path parameters

bankstring · uuidRequired

Responses

200

OK

application/jsontext/json

Responseboolean

head

/api/evaluation/banks/{bank}

HTTPcURLJavaScriptPython

HEAD /v2/e01/api/evaluation/banks/{bank} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

true

Collects the list of banks that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid | nullableOptional

departmentIdentifierstring · uuid | nullableOptional

frameworkIdentifierstring · uuid | nullableOptional

organizationIdentifierstring · uuid | nullableOptional

isActiveboolean | nullableOptional

bankEditionstring | nullableOptional

bankLevelstring | nullableOptional

bankNamestring | nullableOptional

bankStatusstring | nullableOptional

bankTitlestring | nullableOptional

bankTypestring | nullableOptional

lastChangeTypestring | nullableOptional

lastChangeUserstring | nullableOptional

assetNumberinteger · int32 | nullableOptional

attachmentCountinteger · int32 | nullableOptional

bankSizeinteger · int32 | nullableOptional

commentCountinteger · int32 | nullableOptional

formCountinteger · int32 | nullableOptional

optionCountinteger · int32 | nullableOptional

questionCountinteger · int32 | nullableOptional

setCountinteger · int32 | nullableOptional

specCountinteger · int32 | nullableOptional

lastChangeTimestring · date-time | nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/evaluation/banks/collect

HTTPcURLJavaScriptPython

POST /v2/e01/api/evaluation/banks/collect HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 991

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-22T14:51:43.318Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "departmentIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "frameworkIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "isActive": true,
  "bankEdition": "text",
  "bankLevel": "text",
  "bankName": "text",
  "bankStatus": "text",
  "bankTitle": "text",
  "bankType": "text",
  "lastChangeType": "text",
  "lastChangeUser": "text",
  "assetNumber": 1,
  "attachmentCount": 1,
  "bankSize": 1,
  "commentCount": 1,
  "formCount": 1,
  "optionCount": 1,
  "questionCount": 1,
  "setCount": 1,
  "specCount": 1,
  "lastChangeTime": "2026-01-22T14:51:43.318Z"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

[
  {
    "bankIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "departmentIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "frameworkIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "isActive": true,
    "bankEdition": "text",
    "bankLevel": "text",
    "bankName": "text",
    "bankStatus": "text",
    "bankTitle": "text",
    "bankType": "text",
    "lastChangeType": "text",
    "lastChangeUser": "text",
    "assetNumber": 1,
    "attachmentCount": 1,
    "bankSize": 1,
    "commentCount": 1,
    "formCount": 1,
    "optionCount": 1,
    "questionCount": 1,
    "setCount": 1,
    "specCount": 1,
    "lastChangeTime": "2026-01-22T14:51:43.318Z"
  }
]

Counts the banks that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid | nullableOptional

departmentIdentifierstring · uuid | nullableOptional

frameworkIdentifierstring · uuid | nullableOptional

organizationIdentifierstring · uuid | nullableOptional

isActiveboolean | nullableOptional

bankEditionstring | nullableOptional

bankLevelstring | nullableOptional

bankNamestring | nullableOptional

bankStatusstring | nullableOptional

bankTitlestring | nullableOptional

bankTypestring | nullableOptional

lastChangeTypestring | nullableOptional

lastChangeUserstring | nullableOptional

assetNumberinteger · int32 | nullableOptional

attachmentCountinteger · int32 | nullableOptional

bankSizeinteger · int32 | nullableOptional

commentCountinteger · int32 | nullableOptional

formCountinteger · int32 | nullableOptional

optionCountinteger · int32 | nullableOptional

questionCountinteger · int32 | nullableOptional

setCountinteger · int32 | nullableOptional

specCountinteger · int32 | nullableOptional

lastChangeTimestring · date-time | nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/evaluation/banks/count

HTTPcURLJavaScriptPython

POST /v2/e01/api/evaluation/banks/count HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 991

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-22T14:51:43.318Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "departmentIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "frameworkIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "isActive": true,
  "bankEdition": "text",
  "bankLevel": "text",
  "bankName": "text",
  "bankStatus": "text",
  "bankTitle": "text",
  "bankType": "text",
  "lastChangeType": "text",
  "lastChangeUser": "text",
  "assetNumber": 1,
  "attachmentCount": 1,
  "bankSize": 1,
  "commentCount": 1,
  "formCount": 1,
  "optionCount": 1,
  "questionCount": 1,
  "setCount": 1,
  "specCount": 1,
  "lastChangeTime": "2026-01-22T14:51:43.318Z"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

{
  "count": 1,
  "summary": "text"
}

Downloads the list of banks that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid | nullableOptional

departmentIdentifierstring · uuid | nullableOptional

frameworkIdentifierstring · uuid | nullableOptional

organizationIdentifierstring · uuid | nullableOptional

isActiveboolean | nullableOptional

bankEditionstring | nullableOptional

bankLevelstring | nullableOptional

bankNamestring | nullableOptional

bankStatusstring | nullableOptional

bankTitlestring | nullableOptional

bankTypestring | nullableOptional

lastChangeTypestring | nullableOptional

lastChangeUserstring | nullableOptional

assetNumberinteger · int32 | nullableOptional

attachmentCountinteger · int32 | nullableOptional

bankSizeinteger · int32 | nullableOptional

commentCountinteger · int32 | nullableOptional

formCountinteger · int32 | nullableOptional

optionCountinteger · int32 | nullableOptional

questionCountinteger · int32 | nullableOptional

setCountinteger · int32 | nullableOptional

specCountinteger · int32 | nullableOptional

lastChangeTimestring · date-time | nullableOptional

Responses

200

OK

No content

post

/api/evaluation/banks/download

HTTPcURLJavaScriptPython

POST /v2/e01/api/evaluation/banks/download HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 991

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-22T14:51:43.318Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "departmentIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "frameworkIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "isActive": true,
  "bankEdition": "text",
  "bankLevel": "text",
  "bankName": "text",
  "bankStatus": "text",
  "bankTitle": "text",
  "bankType": "text",
  "lastChangeType": "text",
  "lastChangeUser": "text",
  "assetNumber": 1,
  "attachmentCount": 1,
  "bankSize": 1,
  "commentCount": 1,
  "formCount": 1,
  "optionCount": 1,
  "questionCount": 1,
  "setCount": 1,
  "specCount": 1,
  "lastChangeTime": "2026-01-22T14:51:43.318Z"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

No content

Searches for the list of banks that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid | nullableOptional

departmentIdentifierstring · uuid | nullableOptional

frameworkIdentifierstring · uuid | nullableOptional

organizationIdentifierstring · uuid | nullableOptional

isActiveboolean | nullableOptional

bankEditionstring | nullableOptional

bankLevelstring | nullableOptional

bankNamestring | nullableOptional

bankStatusstring | nullableOptional

bankTitlestring | nullableOptional

bankTypestring | nullableOptional

lastChangeTypestring | nullableOptional

lastChangeUserstring | nullableOptional

assetNumberinteger · int32 | nullableOptional

attachmentCountinteger · int32 | nullableOptional

bankSizeinteger · int32 | nullableOptional

commentCountinteger · int32 | nullableOptional

formCountinteger · int32 | nullableOptional

optionCountinteger · int32 | nullableOptional

questionCountinteger · int32 | nullableOptional

setCountinteger · int32 | nullableOptional

specCountinteger · int32 | nullableOptional

lastChangeTimestring · date-time | nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/evaluation/banks/search

HTTPcURLJavaScriptPython

POST /v2/e01/api/evaluation/banks/search HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 991

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-22T14:51:43.318Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "departmentIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "frameworkIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "isActive": true,
  "bankEdition": "text",
  "bankLevel": "text",
  "bankName": "text",
  "bankStatus": "text",
  "bankTitle": "text",
  "bankType": "text",
  "lastChangeType": "text",
  "lastChangeUser": "text",
  "assetNumber": 1,
  "attachmentCount": 1,
  "bankSize": 1,
  "commentCount": 1,
  "formCount": 1,
  "optionCount": 1,
  "questionCount": 1,
  "setCount": 1,
  "specCount": 1,
  "lastChangeTime": "2026-01-22T14:51:43.318Z"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

[
  {
    "bankIdentifier": "123e4567-e89b-12d3-a456-426614174000"
  }
]

Retrieves one specific bank form

get

Authorizations

BearerCookie

BearerstringRequired

Path parameters

formstring · uuidRequired

Responses

200

OK

application/jsontext/json

get

/api/evaluation/banks-forms/{form}

HTTPcURLJavaScriptPython

GET /v2/e01/api/evaluation/banks-forms/{form} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

{
  "bankIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "formIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "gradebookIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "specIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "whenAttemptCompletedNotifyAdminMessageIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "whenAttemptStartedNotifyAdminMessageIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "formHasDiagrams": true,
  "formThirdPartyAssessmentIsEnabled": true,
  "bankLevelType": "text",
  "formClassificationInstrument": "text",
  "formCode": "text",
  "formHasReferenceMaterials": "text",
  "formHook": "text",
  "formInstructionsForOnline": "text",
  "formInstructionsForPaper": "text",
  "formIntroduction": "text",
  "formMaterialsForDistribution": "text",
  "formMaterialsForParticipation": "text",
  "formName": "text",
  "formOrigin": "text",
  "formPublicationStatus": "text",
  "formSource": "text",
  "formSummary": "text",
  "formTitle": "text",
  "formType": "text",
  "formVersion": "text",
  "attemptGradedCount": 1,
  "attemptPassedCount": 1,
  "attemptStartedCount": 1,
  "attemptSubmittedCount": 1,
  "fieldCount": 1,
  "formAsset": 1,
  "formAssetVersion": 1,
  "formAttemptLimit": 1,
  "formTimeLimit": 1,
  "sectionCount": 1,
  "specQuestionLimit": 1,
  "formPassingScore": 1,
  "formFirstPublished": "2026-01-22T14:51:43.318Z"
}

Checks for the existence of one specific bank form

head

Authorizations

BearerCookie

BearerstringRequired

Path parameters

formstring · uuidRequired

Responses

200

OK

application/jsontext/json

Responseboolean

head

/api/evaluation/banks-forms/{form}

HTTPcURLJavaScriptPython

HEAD /v2/e01/api/evaluation/banks-forms/{form} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

true

Collects the list of bank forms that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid | nullableOptional

bankIdentifierstring · uuid | nullableOptional

gradebookIdentifierstring · uuid | nullableOptional

organizationIdentifierstring · uuid | nullableOptional

specIdentifierstring · uuid | nullableOptional

whenAttemptCompletedNotifyAdminMessageIdentifierstring · uuid | nullableOptional

whenAttemptStartedNotifyAdminMessageIdentifierstring · uuid | nullableOptional

formHasDiagramsboolean | nullableOptional

formThirdPartyAssessmentIsEnabledboolean | nullableOptional

bankLevelTypestring | nullableOptional

formClassificationInstrumentstring | nullableOptional

formCodestring | nullableOptional

formHasReferenceMaterialsstring | nullableOptional

formHookstring | nullableOptional

formInstructionsForOnlinestring | nullableOptional

formInstructionsForPaperstring | nullableOptional

formIntroductionstring | nullableOptional

formMaterialsForDistributionstring | nullableOptional

formMaterialsForParticipationstring | nullableOptional

formNamestring | nullableOptional

formOriginstring | nullableOptional

formPublicationStatusstring | nullableOptional

formSourcestring | nullableOptional

formSummarystring | nullableOptional

formTitlestring | nullableOptional

formTypestring | nullableOptional

formVersionstring | nullableOptional

attemptGradedCountinteger · int32 | nullableOptional

attemptPassedCountinteger · int32 | nullableOptional

attemptStartedCountinteger · int32 | nullableOptional

attemptSubmittedCountinteger · int32 | nullableOptional

fieldCountinteger · int32 | nullableOptional

formAssetinteger · int32 | nullableOptional

formAssetVersioninteger · int32 | nullableOptional

formAttemptLimitinteger · int32 | nullableOptional

formTimeLimitinteger · int32 | nullableOptional

sectionCountinteger · int32 | nullableOptional

specQuestionLimitinteger · int32 | nullableOptional

formPassingScorenumber · double | nullableOptional

formFirstPublishedstring · date-time | nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/evaluation/banks-forms/collect

HTTPcURLJavaScriptPython

POST /v2/e01/api/evaluation/banks-forms/collect HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 1684

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-22T14:51:43.318Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "bankIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "gradebookIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "specIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "whenAttemptCompletedNotifyAdminMessageIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "whenAttemptStartedNotifyAdminMessageIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "formHasDiagrams": true,
  "formThirdPartyAssessmentIsEnabled": true,
  "bankLevelType": "text",
  "formClassificationInstrument": "text",
  "formCode": "text",
  "formHasReferenceMaterials": "text",
  "formHook": "text",
  "formInstructionsForOnline": "text",
  "formInstructionsForPaper": "text",
  "formIntroduction": "text",
  "formMaterialsForDistribution": "text",
  "formMaterialsForParticipation": "text",
  "formName": "text",
  "formOrigin": "text",
  "formPublicationStatus": "text",
  "formSource": "text",
  "formSummary": "text",
  "formTitle": "text",
  "formType": "text",
  "formVersion": "text",
  "attemptGradedCount": 1,
  "attemptPassedCount": 1,
  "attemptStartedCount": 1,
  "attemptSubmittedCount": 1,
  "fieldCount": 1,
  "formAsset": 1,
  "formAssetVersion": 1,
  "formAttemptLimit": 1,
  "formTimeLimit": 1,
  "sectionCount": 1,
  "specQuestionLimit": 1,
  "formPassingScore": 1,
  "formFirstPublished": "2026-01-22T14:51:43.318Z"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

[
  {
    "bankIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "formIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "gradebookIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "specIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "whenAttemptCompletedNotifyAdminMessageIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "whenAttemptStartedNotifyAdminMessageIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "formHasDiagrams": true,
    "formThirdPartyAssessmentIsEnabled": true,
    "bankLevelType": "text",
    "formClassificationInstrument": "text",
    "formCode": "text",
    "formHasReferenceMaterials": "text",
    "formHook": "text",
    "formInstructionsForOnline": "text",
    "formInstructionsForPaper": "text",
    "formIntroduction": "text",
    "formMaterialsForDistribution": "text",
    "formMaterialsForParticipation": "text",
    "formName": "text",
    "formOrigin": "text",
    "formPublicationStatus": "text",
    "formSource": "text",
    "formSummary": "text",
    "formTitle": "text",
    "formType": "text",
    "formVersion": "text",
    "attemptGradedCount": 1,
    "attemptPassedCount": 1,
    "attemptStartedCount": 1,
    "attemptSubmittedCount": 1,
    "fieldCount": 1,
    "formAsset": 1,
    "formAssetVersion": 1,
    "formAttemptLimit": 1,
    "formTimeLimit": 1,
    "sectionCount": 1,
    "specQuestionLimit": 1,
    "formPassingScore": 1,
    "formFirstPublished": "2026-01-22T14:51:43.318Z"
  }
]

Counts the bank forms that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid | nullableOptional

bankIdentifierstring · uuid | nullableOptional

gradebookIdentifierstring · uuid | nullableOptional

organizationIdentifierstring · uuid | nullableOptional

specIdentifierstring · uuid | nullableOptional

whenAttemptCompletedNotifyAdminMessageIdentifierstring · uuid | nullableOptional

whenAttemptStartedNotifyAdminMessageIdentifierstring · uuid | nullableOptional

formHasDiagramsboolean | nullableOptional

formThirdPartyAssessmentIsEnabledboolean | nullableOptional

bankLevelTypestring | nullableOptional

formClassificationInstrumentstring | nullableOptional

formCodestring | nullableOptional

formHasReferenceMaterialsstring | nullableOptional

formHookstring | nullableOptional

formInstructionsForOnlinestring | nullableOptional

formInstructionsForPaperstring | nullableOptional

formIntroductionstring | nullableOptional

formMaterialsForDistributionstring | nullableOptional

formMaterialsForParticipationstring | nullableOptional

formNamestring | nullableOptional

formOriginstring | nullableOptional

formPublicationStatusstring | nullableOptional

formSourcestring | nullableOptional

formSummarystring | nullableOptional

formTitlestring | nullableOptional

formTypestring | nullableOptional

formVersionstring | nullableOptional

attemptGradedCountinteger · int32 | nullableOptional

attemptPassedCountinteger · int32 | nullableOptional

attemptStartedCountinteger · int32 | nullableOptional

attemptSubmittedCountinteger · int32 | nullableOptional

fieldCountinteger · int32 | nullableOptional

formAssetinteger · int32 | nullableOptional

formAssetVersioninteger · int32 | nullableOptional

formAttemptLimitinteger · int32 | nullableOptional

formTimeLimitinteger · int32 | nullableOptional

sectionCountinteger · int32 | nullableOptional

specQuestionLimitinteger · int32 | nullableOptional

formPassingScorenumber · double | nullableOptional

formFirstPublishedstring · date-time | nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/evaluation/banks-forms/count

HTTPcURLJavaScriptPython

POST /v2/e01/api/evaluation/banks-forms/count HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 1684

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-22T14:51:43.318Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "bankIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "gradebookIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "specIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "whenAttemptCompletedNotifyAdminMessageIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "whenAttemptStartedNotifyAdminMessageIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "formHasDiagrams": true,
  "formThirdPartyAssessmentIsEnabled": true,
  "bankLevelType": "text",
  "formClassificationInstrument": "text",
  "formCode": "text",
  "formHasReferenceMaterials": "text",
  "formHook": "text",
  "formInstructionsForOnline": "text",
  "formInstructionsForPaper": "text",
  "formIntroduction": "text",
  "formMaterialsForDistribution": "text",
  "formMaterialsForParticipation": "text",
  "formName": "text",
  "formOrigin": "text",
  "formPublicationStatus": "text",
  "formSource": "text",
  "formSummary": "text",
  "formTitle": "text",
  "formType": "text",
  "formVersion": "text",
  "attemptGradedCount": 1,
  "attemptPassedCount": 1,
  "attemptStartedCount": 1,
  "attemptSubmittedCount": 1,
  "fieldCount": 1,
  "formAsset": 1,
  "formAssetVersion": 1,
  "formAttemptLimit": 1,
  "formTimeLimit": 1,
  "sectionCount": 1,
  "specQuestionLimit": 1,
  "formPassingScore": 1,
  "formFirstPublished": "2026-01-22T14:51:43.318Z"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

{
  "count": 1,
  "summary": "text"
}

Downloads the list of bank forms that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid | nullableOptional

bankIdentifierstring · uuid | nullableOptional

gradebookIdentifierstring · uuid | nullableOptional

organizationIdentifierstring · uuid | nullableOptional

specIdentifierstring · uuid | nullableOptional

whenAttemptCompletedNotifyAdminMessageIdentifierstring · uuid | nullableOptional

whenAttemptStartedNotifyAdminMessageIdentifierstring · uuid | nullableOptional

formHasDiagramsboolean | nullableOptional

formThirdPartyAssessmentIsEnabledboolean | nullableOptional

bankLevelTypestring | nullableOptional

formClassificationInstrumentstring | nullableOptional

formCodestring | nullableOptional

formHasReferenceMaterialsstring | nullableOptional

formHookstring | nullableOptional

formInstructionsForOnlinestring | nullableOptional

formInstructionsForPaperstring | nullableOptional

formIntroductionstring | nullableOptional

formMaterialsForDistributionstring | nullableOptional

formMaterialsForParticipationstring | nullableOptional

formNamestring | nullableOptional

formOriginstring | nullableOptional

formPublicationStatusstring | nullableOptional

formSourcestring | nullableOptional

formSummarystring | nullableOptional

formTitlestring | nullableOptional

formTypestring | nullableOptional

formVersionstring | nullableOptional

attemptGradedCountinteger · int32 | nullableOptional

attemptPassedCountinteger · int32 | nullableOptional

attemptStartedCountinteger · int32 | nullableOptional

attemptSubmittedCountinteger · int32 | nullableOptional

fieldCountinteger · int32 | nullableOptional

formAssetinteger · int32 | nullableOptional

formAssetVersioninteger · int32 | nullableOptional

formAttemptLimitinteger · int32 | nullableOptional

formTimeLimitinteger · int32 | nullableOptional

sectionCountinteger · int32 | nullableOptional

specQuestionLimitinteger · int32 | nullableOptional

formPassingScorenumber · double | nullableOptional

formFirstPublishedstring · date-time | nullableOptional

Responses

200

OK

No content

post

/api/evaluation/banks-forms/download

HTTPcURLJavaScriptPython

POST /v2/e01/api/evaluation/banks-forms/download HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 1684

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-22T14:51:43.318Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "bankIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "gradebookIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "specIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "whenAttemptCompletedNotifyAdminMessageIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "whenAttemptStartedNotifyAdminMessageIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "formHasDiagrams": true,
  "formThirdPartyAssessmentIsEnabled": true,
  "bankLevelType": "text",
  "formClassificationInstrument": "text",
  "formCode": "text",
  "formHasReferenceMaterials": "text",
  "formHook": "text",
  "formInstructionsForOnline": "text",
  "formInstructionsForPaper": "text",
  "formIntroduction": "text",
  "formMaterialsForDistribution": "text",
  "formMaterialsForParticipation": "text",
  "formName": "text",
  "formOrigin": "text",
  "formPublicationStatus": "text",
  "formSource": "text",
  "formSummary": "text",
  "formTitle": "text",
  "formType": "text",
  "formVersion": "text",
  "attemptGradedCount": 1,
  "attemptPassedCount": 1,
  "attemptStartedCount": 1,
  "attemptSubmittedCount": 1,
  "fieldCount": 1,
  "formAsset": 1,
  "formAssetVersion": 1,
  "formAttemptLimit": 1,
  "formTimeLimit": 1,
  "sectionCount": 1,
  "specQuestionLimit": 1,
  "formPassingScore": 1,
  "formFirstPublished": "2026-01-22T14:51:43.318Z"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

No content

Searches for the list of bank forms that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid | nullableOptional

bankIdentifierstring · uuid | nullableOptional

gradebookIdentifierstring · uuid | nullableOptional

organizationIdentifierstring · uuid | nullableOptional

specIdentifierstring · uuid | nullableOptional

whenAttemptCompletedNotifyAdminMessageIdentifierstring · uuid | nullableOptional

whenAttemptStartedNotifyAdminMessageIdentifierstring · uuid | nullableOptional

formHasDiagramsboolean | nullableOptional

formThirdPartyAssessmentIsEnabledboolean | nullableOptional

bankLevelTypestring | nullableOptional

formClassificationInstrumentstring | nullableOptional

formCodestring | nullableOptional

formHasReferenceMaterialsstring | nullableOptional

formHookstring | nullableOptional

formInstructionsForOnlinestring | nullableOptional

formInstructionsForPaperstring | nullableOptional

formIntroductionstring | nullableOptional

formMaterialsForDistributionstring | nullableOptional

formMaterialsForParticipationstring | nullableOptional

formNamestring | nullableOptional

formOriginstring | nullableOptional

formPublicationStatusstring | nullableOptional

formSourcestring | nullableOptional

formSummarystring | nullableOptional

formTitlestring | nullableOptional

formTypestring | nullableOptional

formVersionstring | nullableOptional

attemptGradedCountinteger · int32 | nullableOptional

attemptPassedCountinteger · int32 | nullableOptional

attemptStartedCountinteger · int32 | nullableOptional

attemptSubmittedCountinteger · int32 | nullableOptional

fieldCountinteger · int32 | nullableOptional

formAssetinteger · int32 | nullableOptional

formAssetVersioninteger · int32 | nullableOptional

formAttemptLimitinteger · int32 | nullableOptional

formTimeLimitinteger · int32 | nullableOptional

sectionCountinteger · int32 | nullableOptional

specQuestionLimitinteger · int32 | nullableOptional

formPassingScorenumber · double | nullableOptional

formFirstPublishedstring · date-time | nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/evaluation/banks-forms/search

HTTPcURLJavaScriptPython

POST /v2/e01/api/evaluation/banks-forms/search HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 1684

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-22T14:51:43.318Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "bankIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "gradebookIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "specIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "whenAttemptCompletedNotifyAdminMessageIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "whenAttemptStartedNotifyAdminMessageIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "formHasDiagrams": true,
  "formThirdPartyAssessmentIsEnabled": true,
  "bankLevelType": "text",
  "formClassificationInstrument": "text",
  "formCode": "text",
  "formHasReferenceMaterials": "text",
  "formHook": "text",
  "formInstructionsForOnline": "text",
  "formInstructionsForPaper": "text",
  "formIntroduction": "text",
  "formMaterialsForDistribution": "text",
  "formMaterialsForParticipation": "text",
  "formName": "text",
  "formOrigin": "text",
  "formPublicationStatus": "text",
  "formSource": "text",
  "formSummary": "text",
  "formTitle": "text",
  "formType": "text",
  "formVersion": "text",
  "attemptGradedCount": 1,
  "attemptPassedCount": 1,
  "attemptStartedCount": 1,
  "attemptSubmittedCount": 1,
  "fieldCount": 1,
  "formAsset": 1,
  "formAssetVersion": 1,
  "formAttemptLimit": 1,
  "formTimeLimit": 1,
  "sectionCount": 1,
  "specQuestionLimit": 1,
  "formPassingScore": 1,
  "formFirstPublished": "2026-01-22T14:51:43.318Z"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

[
  {
    "formIdentifier": "123e4567-e89b-12d3-a456-426614174000"
  }
]

Retrieves one specific bank form question gradeitem

get

Authorizations

BearerCookie

BearerstringRequired

Path parameters

formstring · uuidRequired

questionstring · uuidRequired

Responses

200

OK

application/jsontext/json

get

/api/evaluation/banks-forms-questions-gradeitems/{form}/{question}

HTTPcURLJavaScriptPython

GET /v2/e01/api/evaluation/banks-forms-questions-gradeitems/{form}/{question} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

{
  "formIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "gradeItemIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "questionIdentifier": "123e4567-e89b-12d3-a456-426614174000"
}

Checks for the existence of one specific bank form question gradeitem

head

Authorizations

BearerCookie

BearerstringRequired

Path parameters

formstring · uuidRequired

questionstring · uuidRequired

Responses

200

OK

application/jsontext/json

Responseboolean

head

/api/evaluation/banks-forms-questions-gradeitems/{form}/{question}

HTTPcURLJavaScriptPython

HEAD /v2/e01/api/evaluation/banks-forms-questions-gradeitems/{form}/{question} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

true

Collects the list of bank form question gradeitems that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid | nullableOptional

gradeItemIdentifierstring · uuid | nullableOptional

organizationIdentifierstring · uuid | nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/evaluation/banks-forms-questions-gradeitems/collect

HTTPcURLJavaScriptPython

POST /v2/e01/api/evaluation/banks-forms-questions-gradeitems/collect HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 565

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-22T14:51:43.318Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "gradeItemIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

[
  {
    "formIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "gradeItemIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "questionIdentifier": "123e4567-e89b-12d3-a456-426614174000"
  }
]

Counts the bank form question gradeitems that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid | nullableOptional

gradeItemIdentifierstring · uuid | nullableOptional

organizationIdentifierstring · uuid | nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/evaluation/banks-forms-questions-gradeitems/count

HTTPcURLJavaScriptPython

POST /v2/e01/api/evaluation/banks-forms-questions-gradeitems/count HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 565

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-22T14:51:43.318Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "gradeItemIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

{
  "count": 1,
  "summary": "text"
}

Downloads the list of bank form question gradeitems that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid | nullableOptional

gradeItemIdentifierstring · uuid | nullableOptional

organizationIdentifierstring · uuid | nullableOptional

Responses

200

OK

No content

post

/api/evaluation/banks-forms-questions-gradeitems/download

HTTPcURLJavaScriptPython

POST /v2/e01/api/evaluation/banks-forms-questions-gradeitems/download HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 565

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-22T14:51:43.318Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "gradeItemIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

No content

Searches for the list of bank form question gradeitems that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid | nullableOptional

gradeItemIdentifierstring · uuid | nullableOptional

organizationIdentifierstring · uuid | nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/evaluation/banks-forms-questions-gradeitems/search

HTTPcURLJavaScriptPython

POST /v2/e01/api/evaluation/banks-forms-questions-gradeitems/search HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 565

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-22T14:51:43.318Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "gradeItemIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

[
  {
    "formIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "questionIdentifier": "123e4567-e89b-12d3-a456-426614174000"
  }
]

Retrieves one specific bank option

get

Authorizations

BearerCookie

BearerstringRequired

Path parameters

optionKeyinteger · int32Required

questionstring · uuidRequired

bankstringRequired

optionstringRequired

Responses

200

OK

application/jsontext/json

get

/api/evaluation/banks-options/{bank}/{option}

HTTPcURLJavaScriptPython

GET /v2/e01/api/evaluation/banks-options/{bank}/{option} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

{
  "bankIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "competencyIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "questionIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "setIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "optionText": "text",
  "optionKey": 1
}

Checks for the existence of one specific bank option

head

Authorizations

BearerCookie

BearerstringRequired

Path parameters

optionKeyinteger · int32Required

questionstring · uuidRequired

bankstringRequired

optionstringRequired

Responses

200

OK

application/jsontext/json

Responseboolean

head

/api/evaluation/banks-options/{bank}/{option}

HTTPcURLJavaScriptPython

HEAD /v2/e01/api/evaluation/banks-options/{bank}/{option} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

true

Collects the list of bank options that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid | nullableOptional

bankIdentifierstring · uuid | nullableOptional

competencyIdentifierstring · uuid | nullableOptional

organizationIdentifierstring · uuid | nullableOptional

setIdentifierstring · uuid | nullableOptional

optionTextstring | nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/evaluation/banks-options/collect

HTTPcURLJavaScriptPython

POST /v2/e01/api/evaluation/banks-options/collect HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 697

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-22T14:51:43.318Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "bankIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "competencyIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "setIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "optionText": "text"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

[
  {
    "bankIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "competencyIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "questionIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "setIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "optionText": "text",
    "optionKey": 1
  }
]

Counts the bank options that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid | nullableOptional

bankIdentifierstring · uuid | nullableOptional

competencyIdentifierstring · uuid | nullableOptional

organizationIdentifierstring · uuid | nullableOptional

setIdentifierstring · uuid | nullableOptional

optionTextstring | nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/evaluation/banks-options/count

HTTPcURLJavaScriptPython

POST /v2/e01/api/evaluation/banks-options/count HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 697

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-22T14:51:43.318Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "bankIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "competencyIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "setIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "optionText": "text"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

{
  "count": 1,
  "summary": "text"
}

Downloads the list of bank options that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid | nullableOptional

bankIdentifierstring · uuid | nullableOptional

competencyIdentifierstring · uuid | nullableOptional

organizationIdentifierstring · uuid | nullableOptional

setIdentifierstring · uuid | nullableOptional

optionTextstring | nullableOptional

Responses

200

OK

No content

post

/api/evaluation/banks-options/download

HTTPcURLJavaScriptPython

POST /v2/e01/api/evaluation/banks-options/download HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 697

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-22T14:51:43.318Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "bankIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "competencyIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "setIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "optionText": "text"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

No content

Searches for the list of bank options that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid | nullableOptional

bankIdentifierstring · uuid | nullableOptional

competencyIdentifierstring · uuid | nullableOptional

organizationIdentifierstring · uuid | nullableOptional

setIdentifierstring · uuid | nullableOptional

optionTextstring | nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/evaluation/banks-options/search

HTTPcURLJavaScriptPython

POST /v2/e01/api/evaluation/banks-options/search HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 697

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-22T14:51:43.318Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "bankIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "competencyIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "setIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "optionText": "text"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

[
  {
    "questionIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "optionKey": 1
  }
]

Retrieves one specific bank question attachment

get

Authorizations

BearerCookie

BearerstringRequired

Path parameters

questionstring · uuidRequired

uploadstring · uuidRequired

attachmentstringRequired

Responses

200

OK

application/jsontext/json

get

/api/evaluation/banks-questions-attachments/{question}/{attachment}

HTTPcURLJavaScriptPython

GET /v2/e01/api/evaluation/banks-questions-attachments/{question}/{attachment} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

{
  "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "questionIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "uploadIdentifier": "123e4567-e89b-12d3-a456-426614174000"
}

Checks for the existence of one specific bank question attachment

head

Authorizations

BearerCookie

BearerstringRequired

Path parameters

questionstring · uuidRequired

uploadstring · uuidRequired

attachmentstringRequired

Responses

200

OK

application/jsontext/json

Responseboolean

head

/api/evaluation/banks-questions-attachments/{question}/{attachment}

HTTPcURLJavaScriptPython

HEAD /v2/e01/api/evaluation/banks-questions-attachments/{question}/{attachment} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

true

Collects the list of bank question attachments that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid | nullableOptional

organizationIdentifierstring · uuid | nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/evaluation/banks-questions-attachments/collect

HTTPcURLJavaScriptPython

POST /v2/e01/api/evaluation/banks-questions-attachments/collect HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 504

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-22T14:51:43.318Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

[
  {
    "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "questionIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "uploadIdentifier": "123e4567-e89b-12d3-a456-426614174000"
  }
]

Counts the bank question attachments that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid | nullableOptional

organizationIdentifierstring · uuid | nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/evaluation/banks-questions-attachments/count

HTTPcURLJavaScriptPython

POST /v2/e01/api/evaluation/banks-questions-attachments/count HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 504

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-22T14:51:43.318Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

{
  "count": 1,
  "summary": "text"
}

Downloads the list of bank question attachments that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid | nullableOptional

organizationIdentifierstring · uuid | nullableOptional

Responses

200

OK

No content

post

/api/evaluation/banks-questions-attachments/download

HTTPcURLJavaScriptPython

POST /v2/e01/api/evaluation/banks-questions-attachments/download HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 504

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-22T14:51:43.318Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

No content

Searches for the list of bank question attachments that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid | nullableOptional

organizationIdentifierstring · uuid | nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/evaluation/banks-questions-attachments/search

HTTPcURLJavaScriptPython

POST /v2/e01/api/evaluation/banks-questions-attachments/search HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 504

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-22T14:51:43.318Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

[
  {
    "questionIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "uploadIdentifier": "123e4567-e89b-12d3-a456-426614174000"
  }
]

Retrieves one specific bank question

get

Authorizations

BearerCookie

BearerstringRequired

Path parameters

questionstring · uuidRequired

Responses

200

OK

application/jsontext/json

get

/api/evaluation/banks-questions/{question}

HTTPcURLJavaScriptPython

GET /v2/e01/api/evaluation/banks-questions/{question} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

{
  "bankIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "competencyIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "parentQuestionIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "questionIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "questionSourceIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "rubricIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "setIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "lastChangeType": "text",
  "lastChangeUser": "text",
  "questionAssetNumber": "text",
  "questionCode": "text",
  "questionCondition": "text",
  "questionFlag": "text",
  "questionLikeItemGroup": "text",
  "questionReference": "text",
  "questionSourceAssetNumber": "text",
  "questionTag": "text",
  "questionTags": "text",
  "questionText": "text",
  "questionType": "text",
  "bankIndex": 1,
  "bankSubIndex": 1,
  "questionDifficulty": 1,
  "questionTaxonomy": 1,
  "lastChangeTime": "2026-01-22T14:51:43.318Z",
  "questionFirstPublished": "2026-01-22T14:51:43.318Z"
}

Checks for the existence of one specific bank question

head

Authorizations

BearerCookie

BearerstringRequired

Path parameters

questionstring · uuidRequired

Responses

200

OK

application/jsontext/json

Responseboolean

head

/api/evaluation/banks-questions/{question}

HTTPcURLJavaScriptPython

HEAD /v2/e01/api/evaluation/banks-questions/{question} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

true

Collects the list of bank questions that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid | nullableOptional

bankIdentifierstring · uuid | nullableOptional

competencyIdentifierstring · uuid | nullableOptional

organizationIdentifierstring · uuid | nullableOptional

parentQuestionIdentifierstring · uuid | nullableOptional

questionSourceIdentifierstring · uuid | nullableOptional

rubricIdentifierstring · uuid | nullableOptional

setIdentifierstring · uuid | nullableOptional

lastChangeTypestring | nullableOptional

lastChangeUserstring | nullableOptional

questionAssetNumberstring | nullableOptional

questionCodestring | nullableOptional

questionConditionstring | nullableOptional

questionFlagstring | nullableOptional

questionLikeItemGroupstring | nullableOptional

questionReferencestring | nullableOptional

questionSourceAssetNumberstring | nullableOptional

questionTagstring | nullableOptional

questionTagsstring | nullableOptional

questionTextstring | nullableOptional

questionTypestring | nullableOptional

bankIndexinteger · int32 | nullableOptional

bankSubIndexinteger · int32 | nullableOptional

questionDifficultyinteger · int32 | nullableOptional

questionTaxonomyinteger · int32 | nullableOptional

lastChangeTimestring · date-time | nullableOptional

questionFirstPublishedstring · date-time | nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/evaluation/banks-questions/collect

HTTPcURLJavaScriptPython

POST /v2/e01/api/evaluation/banks-questions/collect HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 1366

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-22T14:51:43.318Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "bankIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "competencyIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "parentQuestionIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "questionSourceIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "rubricIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "setIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "lastChangeType": "text",
  "lastChangeUser": "text",
  "questionAssetNumber": "text",
  "questionCode": "text",
  "questionCondition": "text",
  "questionFlag": "text",
  "questionLikeItemGroup": "text",
  "questionReference": "text",
  "questionSourceAssetNumber": "text",
  "questionTag": "text",
  "questionTags": "text",
  "questionText": "text",
  "questionType": "text",
  "bankIndex": 1,
  "bankSubIndex": 1,
  "questionDifficulty": 1,
  "questionTaxonomy": 1,
  "lastChangeTime": "2026-01-22T14:51:43.318Z",
  "questionFirstPublished": "2026-01-22T14:51:43.318Z"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

[
  {
    "bankIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "competencyIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "parentQuestionIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "questionIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "questionSourceIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "rubricIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "setIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "lastChangeType": "text",
    "lastChangeUser": "text",
    "questionAssetNumber": "text",
    "questionCode": "text",
    "questionCondition": "text",
    "questionFlag": "text",
    "questionLikeItemGroup": "text",
    "questionReference": "text",
    "questionSourceAssetNumber": "text",
    "questionTag": "text",
    "questionTags": "text",
    "questionText": "text",
    "questionType": "text",
    "bankIndex": 1,
    "bankSubIndex": 1,
    "questionDifficulty": 1,
    "questionTaxonomy": 1,
    "lastChangeTime": "2026-01-22T14:51:43.318Z",
    "questionFirstPublished": "2026-01-22T14:51:43.318Z"
  }
]

Counts the bank questions that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid | nullableOptional

bankIdentifierstring · uuid | nullableOptional

competencyIdentifierstring · uuid | nullableOptional

organizationIdentifierstring · uuid | nullableOptional

parentQuestionIdentifierstring · uuid | nullableOptional

questionSourceIdentifierstring · uuid | nullableOptional

rubricIdentifierstring · uuid | nullableOptional

setIdentifierstring · uuid | nullableOptional

lastChangeTypestring | nullableOptional

lastChangeUserstring | nullableOptional

questionAssetNumberstring | nullableOptional

questionCodestring | nullableOptional

questionConditionstring | nullableOptional

questionFlagstring | nullableOptional

questionLikeItemGroupstring | nullableOptional

questionReferencestring | nullableOptional

questionSourceAssetNumberstring | nullableOptional

questionTagstring | nullableOptional

questionTagsstring | nullableOptional

questionTextstring | nullableOptional

questionTypestring | nullableOptional

bankIndexinteger · int32 | nullableOptional

bankSubIndexinteger · int32 | nullableOptional

questionDifficultyinteger · int32 | nullableOptional

questionTaxonomyinteger · int32 | nullableOptional

lastChangeTimestring · date-time | nullableOptional

questionFirstPublishedstring · date-time | nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/evaluation/banks-questions/count

HTTPcURLJavaScriptPython

POST /v2/e01/api/evaluation/banks-questions/count HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 1366

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-22T14:51:43.318Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "bankIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "competencyIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "parentQuestionIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "questionSourceIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "rubricIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "setIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "lastChangeType": "text",
  "lastChangeUser": "text",
  "questionAssetNumber": "text",
  "questionCode": "text",
  "questionCondition": "text",
  "questionFlag": "text",
  "questionLikeItemGroup": "text",
  "questionReference": "text",
  "questionSourceAssetNumber": "text",
  "questionTag": "text",
  "questionTags": "text",
  "questionText": "text",
  "questionType": "text",
  "bankIndex": 1,
  "bankSubIndex": 1,
  "questionDifficulty": 1,
  "questionTaxonomy": 1,
  "lastChangeTime": "2026-01-22T14:51:43.318Z",
  "questionFirstPublished": "2026-01-22T14:51:43.318Z"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

{
  "count": 1,
  "summary": "text"
}

Downloads the list of bank questions that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid | nullableOptional

bankIdentifierstring · uuid | nullableOptional

competencyIdentifierstring · uuid | nullableOptional

organizationIdentifierstring · uuid | nullableOptional

parentQuestionIdentifierstring · uuid | nullableOptional

questionSourceIdentifierstring · uuid | nullableOptional

rubricIdentifierstring · uuid | nullableOptional

setIdentifierstring · uuid | nullableOptional

lastChangeTypestring | nullableOptional

lastChangeUserstring | nullableOptional

questionAssetNumberstring | nullableOptional

questionCodestring | nullableOptional

questionConditionstring | nullableOptional

questionFlagstring | nullableOptional

questionLikeItemGroupstring | nullableOptional

questionReferencestring | nullableOptional

questionSourceAssetNumberstring | nullableOptional

questionTagstring | nullableOptional

questionTagsstring | nullableOptional

questionTextstring | nullableOptional

questionTypestring | nullableOptional

bankIndexinteger · int32 | nullableOptional

bankSubIndexinteger · int32 | nullableOptional

questionDifficultyinteger · int32 | nullableOptional

questionTaxonomyinteger · int32 | nullableOptional

lastChangeTimestring · date-time | nullableOptional

questionFirstPublishedstring · date-time | nullableOptional

Responses

200

OK

No content

post

/api/evaluation/banks-questions/download

HTTPcURLJavaScriptPython

POST /v2/e01/api/evaluation/banks-questions/download HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 1366

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-22T14:51:43.318Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "bankIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "competencyIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "parentQuestionIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "questionSourceIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "rubricIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "setIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "lastChangeType": "text",
  "lastChangeUser": "text",
  "questionAssetNumber": "text",
  "questionCode": "text",
  "questionCondition": "text",
  "questionFlag": "text",
  "questionLikeItemGroup": "text",
  "questionReference": "text",
  "questionSourceAssetNumber": "text",
  "questionTag": "text",
  "questionTags": "text",
  "questionText": "text",
  "questionType": "text",
  "bankIndex": 1,
  "bankSubIndex": 1,
  "questionDifficulty": 1,
  "questionTaxonomy": 1,
  "lastChangeTime": "2026-01-22T14:51:43.318Z",
  "questionFirstPublished": "2026-01-22T14:51:43.318Z"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

No content

Searches for the list of bank questions that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid | nullableOptional

bankIdentifierstring · uuid | nullableOptional

competencyIdentifierstring · uuid | nullableOptional

organizationIdentifierstring · uuid | nullableOptional

parentQuestionIdentifierstring · uuid | nullableOptional

questionSourceIdentifierstring · uuid | nullableOptional

rubricIdentifierstring · uuid | nullableOptional

setIdentifierstring · uuid | nullableOptional

lastChangeTypestring | nullableOptional

lastChangeUserstring | nullableOptional

questionAssetNumberstring | nullableOptional

questionCodestring | nullableOptional

questionConditionstring | nullableOptional

questionFlagstring | nullableOptional

questionLikeItemGroupstring | nullableOptional

questionReferencestring | nullableOptional

questionSourceAssetNumberstring | nullableOptional

questionTagstring | nullableOptional

questionTagsstring | nullableOptional

questionTextstring | nullableOptional

questionTypestring | nullableOptional

bankIndexinteger · int32 | nullableOptional

bankSubIndexinteger · int32 | nullableOptional

questionDifficultyinteger · int32 | nullableOptional

questionTaxonomyinteger · int32 | nullableOptional

lastChangeTimestring · date-time | nullableOptional

questionFirstPublishedstring · date-time | nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/evaluation/banks-questions/search

HTTPcURLJavaScriptPython

POST /v2/e01/api/evaluation/banks-questions/search HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 1366

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-22T14:51:43.318Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "bankIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "competencyIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "parentQuestionIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "questionSourceIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "rubricIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "setIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "lastChangeType": "text",
  "lastChangeUser": "text",
  "questionAssetNumber": "text",
  "questionCode": "text",
  "questionCondition": "text",
  "questionFlag": "text",
  "questionLikeItemGroup": "text",
  "questionReference": "text",
  "questionSourceAssetNumber": "text",
  "questionTag": "text",
  "questionTags": "text",
  "questionText": "text",
  "questionType": "text",
  "bankIndex": 1,
  "bankSubIndex": 1,
  "questionDifficulty": 1,
  "questionTaxonomy": 1,
  "lastChangeTime": "2026-01-22T14:51:43.318Z",
  "questionFirstPublished": "2026-01-22T14:51:43.318Z"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

[
  {
    "questionIdentifier": "123e4567-e89b-12d3-a456-426614174000"
  }
]

Retrieves one specific bank specification

get

Authorizations

BearerCookie

BearerstringRequired

Path parameters

specstring · uuidRequired

specificationstringRequired

Responses

200

OK

application/jsontext/json

get

/api/evaluation/banks-specifications/{specification}

HTTPcURLJavaScriptPython

GET /v2/e01/api/evaluation/banks-specifications/{specification} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

{
  "bankIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "specIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "calcDisclosure": "text",
  "specConsequence": "text",
  "specName": "text",
  "specType": "text",
  "criterionAllCount": 1,
  "criterionPivotCount": 1,
  "criterionTagCount": 1,
  "specAsset": 1,
  "specFormCount": 1,
  "specFormLimit": 1,
  "specQuestionLimit": 1,
  "calcPassingScore": 1
}

Checks for the existence of one specific bank specification

head

Authorizations

BearerCookie

BearerstringRequired

Path parameters

specstring · uuidRequired

specificationstringRequired

Responses

200

OK

application/jsontext/json

Responseboolean

head

/api/evaluation/banks-specifications/{specification}

HTTPcURLJavaScriptPython

HEAD /v2/e01/api/evaluation/banks-specifications/{specification} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

true

Collects the list of bank specifications that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid | nullableOptional

bankIdentifierstring · uuid | nullableOptional

organizationIdentifierstring · uuid | nullableOptional

calcDisclosurestring | nullableOptional

specConsequencestring | nullableOptional

specNamestring | nullableOptional

specTypestring | nullableOptional

criterionAllCountinteger · int32 | nullableOptional

criterionPivotCountinteger · int32 | nullableOptional

criterionTagCountinteger · int32 | nullableOptional

specAssetinteger · int32 | nullableOptional

specFormCountinteger · int32 | nullableOptional

specFormLimitinteger · int32 | nullableOptional

specQuestionLimitinteger · int32 | nullableOptional

calcPassingScorenumber · double | nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/evaluation/banks-specifications/collect

HTTPcURLJavaScriptPython

POST /v2/e01/api/evaluation/banks-specifications/collect HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 806

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-22T14:51:43.318Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "bankIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "calcDisclosure": "text",
  "specConsequence": "text",
  "specName": "text",
  "specType": "text",
  "criterionAllCount": 1,
  "criterionPivotCount": 1,
  "criterionTagCount": 1,
  "specAsset": 1,
  "specFormCount": 1,
  "specFormLimit": 1,
  "specQuestionLimit": 1,
  "calcPassingScore": 1
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

[
  {
    "bankIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "specIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "calcDisclosure": "text",
    "specConsequence": "text",
    "specName": "text",
    "specType": "text",
    "criterionAllCount": 1,
    "criterionPivotCount": 1,
    "criterionTagCount": 1,
    "specAsset": 1,
    "specFormCount": 1,
    "specFormLimit": 1,
    "specQuestionLimit": 1,
    "calcPassingScore": 1
  }
]

Counts the bank specifications that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid | nullableOptional

bankIdentifierstring · uuid | nullableOptional

organizationIdentifierstring · uuid | nullableOptional

calcDisclosurestring | nullableOptional

specConsequencestring | nullableOptional

specNamestring | nullableOptional

specTypestring | nullableOptional

criterionAllCountinteger · int32 | nullableOptional

criterionPivotCountinteger · int32 | nullableOptional

criterionTagCountinteger · int32 | nullableOptional

specAssetinteger · int32 | nullableOptional

specFormCountinteger · int32 | nullableOptional

specFormLimitinteger · int32 | nullableOptional

specQuestionLimitinteger · int32 | nullableOptional

calcPassingScorenumber · double | nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/evaluation/banks-specifications/count

HTTPcURLJavaScriptPython

POST /v2/e01/api/evaluation/banks-specifications/count HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 806

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-22T14:51:43.318Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "bankIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "calcDisclosure": "text",
  "specConsequence": "text",
  "specName": "text",
  "specType": "text",
  "criterionAllCount": 1,
  "criterionPivotCount": 1,
  "criterionTagCount": 1,
  "specAsset": 1,
  "specFormCount": 1,
  "specFormLimit": 1,
  "specQuestionLimit": 1,
  "calcPassingScore": 1
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

{
  "count": 1,
  "summary": "text"
}

Downloads the list of bank specifications that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid | nullableOptional

bankIdentifierstring · uuid | nullableOptional

organizationIdentifierstring · uuid | nullableOptional

calcDisclosurestring | nullableOptional

specConsequencestring | nullableOptional

specNamestring | nullableOptional

specTypestring | nullableOptional

criterionAllCountinteger · int32 | nullableOptional

criterionPivotCountinteger · int32 | nullableOptional

criterionTagCountinteger · int32 | nullableOptional

specAssetinteger · int32 | nullableOptional

specFormCountinteger · int32 | nullableOptional

specFormLimitinteger · int32 | nullableOptional

specQuestionLimitinteger · int32 | nullableOptional

calcPassingScorenumber · double | nullableOptional

Responses

200

OK

No content

post

/api/evaluation/banks-specifications/download

HTTPcURLJavaScriptPython

POST /v2/e01/api/evaluation/banks-specifications/download HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 806

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-22T14:51:43.318Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "bankIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "calcDisclosure": "text",
  "specConsequence": "text",
  "specName": "text",
  "specType": "text",
  "criterionAllCount": 1,
  "criterionPivotCount": 1,
  "criterionTagCount": 1,
  "specAsset": 1,
  "specFormCount": 1,
  "specFormLimit": 1,
  "specQuestionLimit": 1,
  "calcPassingScore": 1
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

No content

Searches for the list of bank specifications that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid | nullableOptional

bankIdentifierstring · uuid | nullableOptional

organizationIdentifierstring · uuid | nullableOptional

calcDisclosurestring | nullableOptional

specConsequencestring | nullableOptional

specNamestring | nullableOptional

specTypestring | nullableOptional

criterionAllCountinteger · int32 | nullableOptional

criterionPivotCountinteger · int32 | nullableOptional

criterionTagCountinteger · int32 | nullableOptional

specAssetinteger · int32 | nullableOptional

specFormCountinteger · int32 | nullableOptional

specFormLimitinteger · int32 | nullableOptional

specQuestionLimitinteger · int32 | nullableOptional

calcPassingScorenumber · double | nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/evaluation/banks-specifications/search

HTTPcURLJavaScriptPython

POST /v2/e01/api/evaluation/banks-specifications/search HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 806

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-22T14:51:43.318Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "bankIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "calcDisclosure": "text",
  "specConsequence": "text",
  "specName": "text",
  "specType": "text",
  "criterionAllCount": 1,
  "criterionPivotCount": 1,
  "criterionTagCount": 1,
  "specAsset": 1,
  "specFormCount": 1,
  "specFormLimit": 1,
  "specQuestionLimit": 1,
  "calcPassingScore": 1
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

[
  {
    "specIdentifier": "123e4567-e89b-12d3-a456-426614174000"
  }
]

Retrieves one specific quiz

get

Authorizations

BearerCookie

BearerstringRequired

Path parameters

quizstring · uuidRequired

Responses

200

OK

application/jsontext/json

get

/api/evaluation/quizzes/{quiz}

HTTPcURLJavaScriptPython

GET /v2/e01/api/evaluation/quizzes/{quiz} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

{
  "gradebookIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "quizIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "quizData": "text",
  "quizName": "text",
  "quizType": "text",
  "attemptLimit": 1,
  "passingKph": 1,
  "passingWpm": 1,
  "timeLimit": 1,
  "maximumPoints": 1,
  "passingAccuracy": 1,
  "passingPoints": 1,
  "passingScore": 1
}

put

Authorizations

BearerCookie

BearerstringRequired

Path parameters

quizstring · uuidRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

gradebookIdentifierstring · uuidOptional

organizationIdentifierstring · uuidOptional

quizIdentifierstring · uuidOptional

quizDatastring | nullableOptional

quizNamestring | nullableOptional

quizTypestring | nullableOptional

attemptLimitinteger · int32Optional

passingKphinteger · int32Optional

passingWpminteger · int32Optional

timeLimitinteger · int32Optional

maximumPointsnumber · double | nullableOptional

passingAccuracynumber · doubleOptional

passingPointsnumber · double | nullableOptional

passingScorenumber · double | nullableOptional

Responses

200

OK

No content

400

Bad Request

application/json

404

Not Found

application/jsontext/json

put

/api/evaluation/quizzes/{quiz}

HTTPcURLJavaScriptPython

PUT /v2/e01/api/evaluation/quizzes/{quiz} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 370

{
  "gradebookIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "quizIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "quizData": "text",
  "quizName": "text",
  "quizType": "text",
  "attemptLimit": 1,
  "passingKph": 1,
  "passingWpm": 1,
  "timeLimit": 1,
  "maximumPoints": 1,
  "passingAccuracy": 1,
  "passingPoints": 1,
  "passingScore": 1
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

No content

delete

Authorizations

BearerCookie

BearerstringRequired

Path parameters

quizstring · uuidRequired

Responses

200

OK

No content

404

Not Found

application/jsontext/json

delete

/api/evaluation/quizzes/{quiz}

HTTPcURLJavaScriptPython

DELETE /v2/e01/api/evaluation/quizzes/{quiz} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

No content

Checks for the existence of one specific quiz

head

Authorizations

BearerCookie

BearerstringRequired

Path parameters

quizstring · uuidRequired

Responses

200

OK

application/jsontext/json

Responseboolean

head

/api/evaluation/quizzes/{quiz}

HTTPcURLJavaScriptPython

HEAD /v2/e01/api/evaluation/quizzes/{quiz} HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Accept: */*

200

OK

true

Collects the list of quizes that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid | nullableOptional

gradebookIdentifierstring · uuid | nullableOptional

organizationIdentifierstring · uuid | nullableOptional

quizDatastring | nullableOptional

quizNamestring | nullableOptional

quizTypestring | nullableOptional

attemptLimitinteger · int32 | nullableOptional

passingKphinteger · int32 | nullableOptional

passingWpminteger · int32 | nullableOptional

timeLimitinteger · int32 | nullableOptional

maximumPointsnumber · double | nullableOptional

passingAccuracynumber · double | nullableOptional

passingPointsnumber · double | nullableOptional

passingScorenumber · double | nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/evaluation/quizzes/collect

HTTPcURLJavaScriptPython

POST /v2/e01/api/evaluation/quizzes/collect HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 753

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-22T14:51:43.318Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "gradebookIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "quizData": "text",
  "quizName": "text",
  "quizType": "text",
  "attemptLimit": 1,
  "passingKph": 1,
  "passingWpm": 1,
  "timeLimit": 1,
  "maximumPoints": 1,
  "passingAccuracy": 1,
  "passingPoints": 1,
  "passingScore": 1
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

[
  {
    "gradebookIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "quizIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "quizData": "text",
    "quizName": "text",
    "quizType": "text",
    "attemptLimit": 1,
    "passingKph": 1,
    "passingWpm": 1,
    "timeLimit": 1,
    "maximumPoints": 1,
    "passingAccuracy": 1,
    "passingPoints": 1,
    "passingScore": 1
  }
]

Counts the quizes that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid | nullableOptional

gradebookIdentifierstring · uuid | nullableOptional

organizationIdentifierstring · uuid | nullableOptional

quizDatastring | nullableOptional

quizNamestring | nullableOptional

quizTypestring | nullableOptional

attemptLimitinteger · int32 | nullableOptional

passingKphinteger · int32 | nullableOptional

passingWpminteger · int32 | nullableOptional

timeLimitinteger · int32 | nullableOptional

maximumPointsnumber · double | nullableOptional

passingAccuracynumber · double | nullableOptional

passingPointsnumber · double | nullableOptional

passingScorenumber · double | nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/evaluation/quizzes/count

HTTPcURLJavaScriptPython

POST /v2/e01/api/evaluation/quizzes/count HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 753

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-22T14:51:43.318Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "gradebookIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "quizData": "text",
  "quizName": "text",
  "quizType": "text",
  "attemptLimit": 1,
  "passingKph": 1,
  "passingWpm": 1,
  "timeLimit": 1,
  "maximumPoints": 1,
  "passingAccuracy": 1,
  "passingPoints": 1,
  "passingScore": 1
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

{
  "count": 1,
  "summary": "text"
}

Downloads the list of quizes that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid | nullableOptional

gradebookIdentifierstring · uuid | nullableOptional

organizationIdentifierstring · uuid | nullableOptional

quizDatastring | nullableOptional

quizNamestring | nullableOptional

quizTypestring | nullableOptional

attemptLimitinteger · int32 | nullableOptional

passingKphinteger · int32 | nullableOptional

passingWpminteger · int32 | nullableOptional

timeLimitinteger · int32 | nullableOptional

maximumPointsnumber · double | nullableOptional

passingAccuracynumber · double | nullableOptional

passingPointsnumber · double | nullableOptional

passingScorenumber · double | nullableOptional

Responses

200

OK

No content

post

/api/evaluation/quizzes/download

HTTPcURLJavaScriptPython

POST /v2/e01/api/evaluation/quizzes/download HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 753

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-22T14:51:43.318Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "gradebookIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "quizData": "text",
  "quizName": "text",
  "quizType": "text",
  "attemptLimit": 1,
  "passingKph": 1,
  "passingWpm": 1,
  "timeLimit": 1,
  "maximumPoints": 1,
  "passingAccuracy": 1,
  "passingPoints": 1,
  "passingScore": 1
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

No content

Searches for the list of quizes that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

identifierstring · uuid | nullableOptional

gradebookIdentifierstring · uuid | nullableOptional

organizationIdentifierstring · uuid | nullableOptional

quizDatastring | nullableOptional

quizNamestring | nullableOptional

quizTypestring | nullableOptional

attemptLimitinteger · int32 | nullableOptional

passingKphinteger · int32 | nullableOptional

passingWpminteger · int32 | nullableOptional

timeLimitinteger · int32 | nullableOptional

maximumPointsnumber · double | nullableOptional

passingAccuracynumber · double | nullableOptional

passingPointsnumber · double | nullableOptional

passingScorenumber · double | nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/evaluation/quizzes/search

HTTPcURLJavaScriptPython

POST /v2/e01/api/evaluation/quizzes/search HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 753

{
  "identifier": "123e4567-e89b-12d3-a456-426614174000",
  "origin": {
    "when": "2026-01-22T14:51:43.318Z",
    "organization": "123e4567-e89b-12d3-a456-426614174000",
    "user": "123e4567-e89b-12d3-a456-426614174000",
    "proxy": "123e4567-e89b-12d3-a456-426614174000",
    "description": "text",
    "reason": "text",
    "source": "text"
  },
  "filter": {
    "page": 1,
    "pageSize": 1,
    "sort": "text",
    "excludes": "text",
    "includes": "text",
    "format": "text"
  },
  "texts": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "gradebookIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "quizData": "text",
  "quizName": "text",
  "quizType": "text",
  "attemptLimit": 1,
  "passingKph": 1,
  "passingWpm": 1,
  "timeLimit": 1,
  "maximumPoints": 1,
  "passingAccuracy": 1,
  "passingPoints": 1,
  "passingScore": 1
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

[
  {
    "quizIdentifier": "123e4567-e89b-12d3-a456-426614174000"
  }
]

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

gradebookIdentifierstring · uuidOptional

organizationIdentifierstring · uuidOptional

quizIdentifierstring · uuidOptional

quizDatastring | nullableOptional

quizNamestring | nullableOptional

quizTypestring | nullableOptional

attemptLimitinteger · int32Optional

passingKphinteger · int32Optional

passingWpminteger · int32Optional

timeLimitinteger · int32Optional

maximumPointsnumber · double | nullableOptional

passingAccuracynumber · doubleOptional

passingPointsnumber · double | nullableOptional

passingScorenumber · double | nullableOptional

Responses

201

Created

application/json

400

Bad Request

application/json

post

/api/evaluation/quizzes

HTTPcURLJavaScriptPython

POST /v2/e01/api/evaluation/quizzes HTTP/1.1
Host: 
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 370

{
  "gradebookIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "quizIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "quizData": "text",
  "quizName": "text",
  "quizType": "text",
  "attemptLimit": 1,
  "passingKph": 1,
  "passingWpm": 1,
  "timeLimit": 1,
  "maximumPoints": 1,
  "passingAccuracy": 1,
  "passingPoints": 1,
  "passingScore": 1
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

{
  "gradebookIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "organizationIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "quizIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "quizData": "text",
  "quizName": "text",
  "quizType": "text",
  "attemptLimit": 1,
  "passingKph": 1,
  "passingWpm": 1,
  "timeLimit": 1,
  "maximumPoints": 1,
  "passingAccuracy": 1,
  "passingPoints": 1,
  "passingScore": 1
}