GET/Collaborators/{collaboratorId}/advanceForms
Returns a collaborator's advances as full forms: area, activity, modules (due date, required and task-tracking flags, template
blocks with their question and request definitions) and the submitted question answers and resource requests. Use it to fill in or
review an advance; for only names and scope use Collaborators_GetCollaboratorAdvanceConfig. Needs read access to the collaborator,
whose id comes from Events_GetCollaborators.
Path Parameters
| Field | Type | Required | Description |
|---|
| collaboratorId | uuid | Required | |
Response
Type: GetCollaboratorAdvances[]
GetCollaboratorAdvances
| Field | Type | Description |
|---|
| id | uuid | |
| name | string| null | |
| area | GetCollaboratorAdvancesAreaObj | |
| activity | GetCollaboratorAdvancesActivityObj | |
| modules | GetCollaboratorAdvancesModule[]| null | |
| questions | GetCollaboratorAdvancesQuestion[]| null | |
| requests | GetCollaboratorAdvancesRequest[]| null | |
GetCollaboratorAdvancesAreaObj
| Field | Type | Description |
|---|
| id | uuid | |
| name | string| null | |
GetCollaboratorAdvancesActivityObj
| Field | Type | Description |
|---|
| id | uuid | |
| name | string| null | |
| startTime | date-time | |
| endTime | date-time | |
GetCollaboratorAdvancesModule
| Field | Type | Description |
|---|
| id | uuid | |
| index | integer | |
| dueDate | date-time | |
| isRequired | boolean | |
| isTaskTracked | boolean | |
| isTaskReviewRequired | boolean | |
| moduleTemplate | GetCollaboratorAdvancesModuleTemplateModule | |
GetCollaboratorAdvancesQuestion
| Field | Type | Description |
|---|
| id | uuid | |
| advanceModuleId | uuid | |
| moduleTemplateBlockId | uuid | |
| questionTemplateId | uuid | |
| taskId | uuid | |
| taskStatusId | uuid | |
| value | string| null | |
GetCollaboratorAdvancesRequest
| Field | Type | Description |
|---|
| id | uuid | |
| advanceModuleId | uuid | |
| moduleTemplateBlockId | uuid | |
| requestTemplateId | uuid | |
| advanceApproved | boolean| null | |
| resourceApproved | boolean| null | |
| taskId | uuid | |
| taskStatusId | uuid | |
| resource | GetCollaboratorAdvancesRequestResourceObj | |
| properties | GetCollaboratorAdvancesRequestRequestProperty[]| null | |
GetCollaboratorAdvancesModuleTemplateModule
| Field | Type | Description |
|---|
| id | uuid | |
| label | string| null | |
| icon | string| null | |
| blocks | GetCollaboratorAdvancesModuleTemplateModuleModuleTemplateBlock[]| null | |
GetCollaboratorAdvancesRequestResourceObj
| Field | Type | Description |
|---|
| id | uuid | |
| type | GetCollaboratorAdvancesRequestResourceObjResourceType | |
| properties | GetCollaboratorAdvancesRequestResourceObjProperty[]| null | |
GetCollaboratorAdvancesRequestRequestProperty
| Field | Type | Description |
|---|
| id | uuid | |
| templatePropertyId | uuid | |
| value | string| null | |