Assessments API: Workshops
get
Authorizations
BearerstringRequired
Path parameters
bankIdstring · uuidRequired
Responses
200
OK
FileNamestring · nullableOptional
Urlstring · nullableOptional
Environmentstring · enumOptionalPossible values:
get
/api/assessments/workshops/banks/{bankId}/images200
OK
get
Authorizations
BearerstringRequired
Path parameters
bankIdstring · uuidRequired
Responses
200
OK
QuestionIdstring · uuidOptional
LastChangeTimestring · date-timeOptional
get
/api/assessments/workshops/banks/{bankId}/question-change-dates200
OK
put
Authorizations
BearerstringRequired
Path parameters
bankIdstring · uuidRequired
questionIdstring · uuidRequired
Body
Fieldstring · enumOptionalPossible values:
ColumnIndexinteger · int32 · nullableOptional
Valuestring · nullableOptional
Responses
200
OK
Htmlstring · nullableOptional
put
/api/assessments/workshops/banks/{bankId}/questions/{questionId}200
OK
put
Authorizations
BearerstringRequired
Path parameters
bankIdstring · uuidRequired
questionIdstring · uuidRequired
optionNumberinteger · int32Required
Body
Fieldstring · enumOptionalPossible values:
ColumnIndexinteger · int32 · nullableOptional
Valuestring · nullableOptional
Responses
200
OK
Htmlstring · nullableOptional
put
/api/assessments/workshops/banks/{bankId}/questions/{questionId}/options/{optionNumber}200
OK
post
Authorizations
BearerstringRequired
Path parameters
bankIdstring · uuidRequired
questionIdstring · uuidRequired
Body
AuthorTypestring · nullableOptional
Flagstring · enumOptionalPossible values:
Textstring · nullableOptional
Responses
200
OK
CandidateCommentCountinteger · int32Optional
post
/api/assessments/workshops/banks/{bankId}/questions/{questionId}/comments200
OK
post
Authorizations
BearerstringRequired
Path parameters
bankIdstring · uuidRequired
fieldIdstring · uuidRequired
Body
AuthorTypestring · nullableOptional
Flagstring · enumOptionalPossible values:
Textstring · nullableOptional
Responses
200
OK
CandidateCommentCountinteger · int32Optional
post
/api/assessments/workshops/banks/{bankId}/fields/{fieldId}/comments200
OK
post
Authorizations
BearerstringRequired
Path parameters
bankIdstring · uuidRequired
fieldIdstring · uuidRequired
Query parameters
commandstring · enumOptionalPossible values:
Responses
200
OK
post
/api/assessments/workshops/banks/{bankId}/fields/{fieldId}/replace200
OK
post
Authorizations
BearerstringRequired
Path parameters
bankIdstring · uuidRequired
specificationIdstring · uuidRequired
setIdstring · uuidRequired
Query parameters
standardIdstring · uuidOptional
commandstring · enumOptionalPossible values:
Responses
200
OK
AreaIdstring · uuid · nullableOptional
QuestionIdstring · uuid · nullableOptional
post
/api/assessments/workshops/banks/{bankId}/specifications/{specificationId}/sets/{setId}/questions200
OK
post
Authorizations
BearerstringRequired
Path parameters
bankIdstring · uuidRequired
specificationIdstring · uuidRequired
setIdstring · uuidRequired
questionIdstring · uuidRequired
Responses
200
OK
AreaIdstring · uuid · nullableOptional
QuestionIdstring · uuid · nullableOptional
post
/api/assessments/workshops/banks/{bankId}/specifications/{specificationId}/sets/{setId}/questions/{questionId}/duplicate200
OK
put
Authorizations
BearerstringRequired
Path parameters
bankIdstring · uuidRequired
commentIdstring · uuidRequired
Query parameters
hiddenbooleanOptional
Responses
200
OK
No content
put
/api/assessments/workshops/banks/{bankId}/comments/{commentId}/showhide200
OK
No content
get
Authorizations
BearerstringRequired
Path parameters
formIdstring · uuidRequired
Query parameters
sectionIdstring · uuidOptional
questionIdstring · uuidOptional
Responses
200
OK
BankIdstring · uuidOptional
get
/api/assessments/workshops/forms/{formId}200
OK
get
Authorizations
BearerstringRequired
Path parameters
formIdstring · uuidRequired
sectionIdstring · uuidRequired
Responses
200
OK
get
/api/assessments/workshops/forms/{formId}/sections/{sectionId}200
OK
put
Authorizations
BearerstringRequired
Path parameters
formIdstring · uuidRequired
Query parameters
enabledbooleanOptional
Responses
200
OK
No content
put
/api/assessments/workshops/forms/{formId}/third-party-assessment200
OK
No content
post
Authorizations
BearerstringRequired
Path parameters
formIdstring · uuidRequired
Responses
200
OK
IsQuestionOrderMatchbooleanOptional
StaticQuestionOrderVerifiedstring · date-time · nullableOptional
post
/api/assessments/workshops/forms/{formId}/verify-static-question-order200
OK
get
Authorizations
BearerstringRequired
Path parameters
specificationIdstring · uuidRequired
Query parameters
sectionIdstring · uuidOptional
questionIdstring · uuidOptional
Responses
200
OK
BankIdstring · uuidOptional
get
/api/assessments/workshops/specs/{specificationId}200
OK
put
Authorizations
BearerstringRequired
Path parameters
specificationIdstring · uuidRequired
Body
FormLimitinteger · int32Optional
QuestionLimitinteger · int32Optional
Responses
200
OK
BankIdstring · uuidOptional
put
/api/assessments/workshops/specs/{specificationId}200
OK
get
Authorizations
BearerstringRequired
Path parameters
specificationIdstring · uuidRequired
setIdstring · uuidRequired
Responses
200
OK
get
/api/assessments/workshops/specs/{specificationId}/sets/{setId}200
OK
Last updated
Was this helpful?