Docs

Get Collaborator Advance Config By Id

GET /Collaborators/{collaboratorId}/advances/{advanceId}

GET/Collaborators/{collaboratorId}/advances/{advanceId}

Returns the configuration of one advance for a collaborator: name, area, activity and its modules with sort order, due date, required flag, task-tracking and task-review flags and template info (id, name, label, icon). The advance id comes from Collaborators_GetCollaboratorAdvanceConfig and the module ids returned here are used by the module operations; needs collaborator admin rights.

Path Parameters

FieldTypeRequiredDescription
collaboratorIduuidRequired
advanceIduuidRequired

Response

FieldTypeDescription
iduuid
namestring| null
areaGetCollaboratorAdvanceConfigurationAreaObj
activityGetCollaboratorAdvanceConfigurationActivityObj
modulesGetCollaboratorAdvanceConfigurationModuleObj[]| null

GetCollaboratorAdvanceConfigurationAreaObj

FieldTypeDescription
iduuid
namestring| null

GetCollaboratorAdvanceConfigurationActivityObj

FieldTypeDescription
iduuid
namestring| null
startTimedate-time
endTimedate-time

GetCollaboratorAdvanceConfigurationModuleObj

FieldTypeDescription
iduuid
indexinteger
dueDatedate-time
isRequiredboolean
isTaskTrackedboolean
isTaskReviewRequiredboolean
moduleGetCollaboratorAdvanceConfigurationModuleObjTemplate

GetCollaboratorAdvanceConfigurationModuleObjTemplate

FieldTypeDescription
iduuid
namestring| null
labelstring| null
iconstring| null