Model: WorkRequestResponse

1 min

Model Parameters

WorkRequestResponse
- idstringrequired
  Example
  5fe4925ef8a9378056bf4e37
  Description
  Unique identifier of the work request
- templateobjectrequired
  Description
  The template, based on the work request that was created
  - idstringrequired
    Example
    1265ca474ba987cc925164aa7
    Description
    Unique identifier of the template
  - titlestringrequired
    Example
    Sample template title
    Description
    Title of the template
  - linksobjectrequired
    Description
    Meta links
    - selfstringrequired
      Example
      https://api.cmp.optimizely.com/v3/templates/9119a313057e401189407116fcd3aa24
      Description
      URL of the template
- reference_idstringrequired
  Example
  WRQ-23
  Description
  Reference identifier of the work request
- assigneesobject[]required
  Description
  List of assigned users to the work request
  - idstringrequired
    Example
    6asdcnfnfdsfdsfd54sgfd54sf
    Description
    Unique identifier of the assignee
  - typestring<user | team>required
    Example
    user
    Description
    Type of the assignee
    Allowed
    userteam
  - full_namestringrequired
    Example
    John Doe
    Description
    Full name of the assignee
  - image_urlstringrequired
    Example
    https://images.cmp.optimizely.com/6a485f72ba424f9397c71ddf0cfb8f59
    Description
    URL of the profile picture of the assignee. null if the assignee has not provided an image
  - linksobjectrequired
    Description
    Meta links
    - selfstringrequired
      Example
      https://api.cmp.optimizely.com/v3/users/6asdcnfnfdsfdsfd54sgfd54sf
      Description
      URL of the assigned user
- statusstring<Accepted | Declined | Submitted | Completed>required
  Example
  Accepted
  Description
  Current status of the work request
  Allowed
  AcceptedDeclinedSubmittedCompleted
- prioritystring<Low | Medium | High>required
  Example
  Medium
  Description
  Priority of the work request
  Allowed
  LowMediumHigh
- created_byobjectrequired
  Description
  Creator of the work request
  - idstringrequired
    Example
    6asdcnfnfdsfdsfd54sgfd54sf
    Description
    Unique identifier of the creator of the work request
  - linksobjectrequired
    Description
    Meta links
    - selfstringrequired
      Example
      https://api.cmp.optimizely.com/v3/users/6asdcnfnfdsfdsfd54sgfd54sf
      Description
      URL of the creator
- created_atstring<date-time>required
  Example
  2022-04-30T06:00:00.000Z
  Description
  Date and time on which the work request was created, in ISO 8601 UTC format (2022-04-30T06:00
  .000Z)
  Format
  date-time
- modified_atstring<date-time>required
  Example
  2022-04-30T08:00:00.000Z
  Description
  Date and time on which the work request was last modified, in ISO 8601 UTC format (2022-04-30T08:00
  .000Z)
  Format
  date-time
- form_fieldsTextTypeFormFieldResponse[]required
  Description
  Populated form fields following the template
  - BaseFormFieldResponse
    - identifierstringrequired
      Example
      brief
      Description
      Identifier of the form field collected from the template form field
    - typestringrequired
      Example
      brief
      Description
      Type of the form field
    - valuesobject[]required
      Description
      Values of the form field
    - is_protectedboolean
      Description
      True when this form field is read-only and only organization admins can modify it. Absent or false for editable fields.
  - object
    - valuesstring[]
- linksobjectrequired
  Description
  Meta links
  - selfstringrequired
    Example
    https://api.cmp.optimizely.com/v3/work-requests/5fe4925ef8a9378056bf4e37
    Description
    URL of the work request
  - commentsstringrequired
    Example
    https://api.cmp.optimizely.com/v3/work-requests/5fe4925ef8a9378056bf4e37/comments
    Description
    URL to create or get work request comments
  - attachmentsstringrequired
    Example
    https://api.cmp.optimizely.com/v3/work-requests/5fe4925ef8a9378056bf4e37/attachments
    Description
    URL to add attachments to work request
  - campaignsstringrequired
    Example
    https://api.cmp.optimizely.com/v3/work-requests/5fe4925ef8a9378056bf4e37/campaigns
    Description
    URL to create a campaign from the work request
  - tasksstringrequired
    Example
    https://api.cmp.optimizely.com/v3/work-requests/5fe4925ef8a9378056bf4e37/tasks
    Description
    URL to create a task from the work request
  - creative_assetsstringrequired
    Example
    https://api.cmp.optimizely.com/v3/work-requests/5fe4925ef8a9378056bf4e37/creative-assets
    Description
    URL to add creative assets to the work request
  - related_resourcesstringrequired
    Example
    https://api.cmp.optimizely.com/v3/work-requests/5fe4925ef8a9378056bf4e37/related-resources
    Description
    URL to get related resources