ZRM Docs
API ReferenceDesign Review

designReview.create

Type: Mutation · Auth: Workspace-aware

Input

FieldTypeRequiredDefaultDescription
workspaceIdstringNoID of the associated workspace
projectIdstringNoID of the associated project
workOrderIdstringNoID of the associated work order
siteIdstringYesID of the associated site
reviewTypeenum(system_design, engineering_approval, bom_validation, as_built)YesReview type
statusenum(pending, in_review, approved, revision_requested, rejected)Yes"pending"Status
titlestringYesTitle
descriptionstringNoDescription
checklistunknownNoChecklist
reviewerIdstringNoID of the associated reviewer
reviewedAtstring.date-timeNoReviewed at
revisionNotesstringNoRevision notes
documentIdsunknownNoDocument ids
visibilityModeenum(global, workspace_local, shared)Yes"workspace_local"Visibility mode

Example

{
  "workspaceId": "550e8400-e29b-41d4-a716-446655440000",
  "projectId": "550e8400-e29b-41d4-a716-446655440000",
  "workOrderId": "550e8400-e29b-41d4-a716-446655440000",
  "siteId": "550e8400-e29b-41d4-a716-446655440000",
  "reviewType": "system_design",
  "status": "pending",
  "title": "Example Title",
  "visibilityMode": "global"
}

On this page