Update a workrequest

PUT /workrequests/{id}

Update a workrequest

cURL

curl --request PUT \
  --url https://api-staging.pixwel.com/api/workrequests/{id} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data @- <<EOF
{
  "_id": "69fbdb6c86bcded891072af3",
  "studio": "53d198844f06409d418b4571",
  "project": {
    "_id": "6865c23ca1199cff5001ec8f",
    "name": "Regretting You",
    "slug": "regrettingyou",
    "studio": "53d198844f06409d418b4571",
    "logo": "6891432c6268b8b96609b3bf",
    "$links": {
      "self": "//api-staging.pixwel.com/api/Projects/regrettingyou"
    }
  },
  "asset": {
    "_id": "69fa4897dbab17ffa2057742",
    "name": "Int'l Trailer A V2 Production",
    "slug": "intl-trailer-a-v2-production",
    "type": "preliminary-production",
    "mediaType": "video",
    "thumbnail": {
      "_id": "69fa4fc413085a78d50d4745",
      "verified": false,
      "embargo": {
        "event": false
      },
      "warnings": [
        "<unknown>"
      ],
      "mime": "image/jpeg",
      "bucket": "pixwel-slurpee2-output-staging-west-2",
      "tags": [
        "<unknown>"
      ],
      "chunkSize": 262144,
      "length": 84699,
      "md5": "ad05d0590a8d662f82b0f3dcd3fa1176",
      "uploadDate": 1778012100,
      "$links": {
        "self": "//api-staging.pixwel.com/api/Files/69fa4fc413085a78d50d4745"
      }
    },
    "transcription": {
      "graphics": "69fbd733db10562a7a02aed3"
    },
    "project": "6865c23ca1199cff5001ec8f",
    "studio": "53d198844f06409d418b4571",
    "creative": false,
    "aspectRatio": "16:9",
    "usage": {
      "broadcast": true,
      "online": true,
      "dcp": true,
      "dcp3d": true,
      "film35": false,
      "film70": false,
      "imax": true,
      "imax3d": true,
      "atmos2d": true,
      "atmos3d": true,
      "dolbyVision2d": true,
      "dolbyVision3d": true
    },
    "workflow": {
      "id": "69b0f76f1c2b56df59074142",
      "phase": "LOCK",
      "definition": {
        "phases": {
          "WIP": {
            "groups": [
              {
                "id": "533b8a8555f4baa0078b45ad",
                "dng": [
                  "<unknown>"
                ],
                "usages": [
                  "<unknown>"
                ]
              }
            ],
            "users": [
              "<unknown>"
            ],
            "terminal": false
          },
          "LOCK": {
            "groups": [
              {
                "id": "533b8a8555f4baa0078b45ad",
                "dng": [
                  "<unknown>"
                ],
                "usages": [
                  "<unknown>"
                ]
              }
            ],
            "users": [
              "<unknown>"
            ],
            "terminal": false
          },
          "FINAL": {
            "groups": [
              {
                "id": "5698315d95fa09f5738b4577",
                "dng": [
                  "graphics_Subtitled"
                ],
                "usages": [
                  "<unknown>"
                ]
              }
            ],
            "users": [
              "<unknown>"
            ],
            "terminal": true
          }
        },
        "requireGraphicsApproval": false,
        "requireOfflineApproval": false
      }
    }
  },
  "assetType": "preliminary-production",
  "assetCategory": "av",
  "auto": false,
  "autosubs": false,
  "dualLanguages": false,
  "aspectRatio": "16:9",
  "from": {
    "_id": "69fbcc47695c40517b08a412",
    "name": "Ryan Workflow",
    "emailNormal": "[e-mail]",
    "groups": [
      {
        "_id": "533b8a9a55f4ba9e078b45ad",
        "name": "PPI Brazil",
        "$links": {
          "self": "//api-staging.pixwel.com/api/Groups/533b8a9a55f4ba9e078b45ad"
        }
      }
    ]
  },
  "due": {
    "date": 1778286181,
    "tz": "America/Los_Angeles"
  },
  "language": "BPO",
  "territory": "BR",
  "dng": {
    "dialogue": [
      "Dedicated / Localized"
    ],
    "graphics": [
      "Dedicated / Localized"
    ],
    "narration": [
      "Dedicated / Localized"
    ]
  },
  "uses": {
    "items": [
      "Online"
    ],
    "details": {
      "Online": [
        {
          "value": "1080p",
          "ship": false
        }
      ]
    }
  },
  "dcp": {
    "items": [
      "<unknown>"
    ],
    "details": [
      "<unknown>"
    ]
  },
  "instructions": "",
  "status": "awaiting-materials",
  "history": [
    {
      "date": 1778113388,
      "user": {
        "_id": "69fbcc47695c40517b08a412",
        "emailNormal": "[e-mail]",
        "name": "Ryan Workflow",
        "groups": [
          {
            "_id": "533b8a9a55f4ba9e078b45ad",
            "name": "PPI Brazil"
          }
        ]
      },
      "status": "incomplete",
      "reason": ""
    }
  ],
  "recipients": {
    "Broadcast": [
      "<unknown>"
    ],
    "Dcp": [
      "<unknown>"
    ],
    "Streamingfile": [
      "<unknown>"
    ],
    "Online": [
      "<unknown>"
    ],
    "Theatrical": [
      "<unknown>"
    ],
    "Cmyk": [
      "<unknown>"
    ],
    "Rgb": [
      "<unknown>"
    ],
    "2D Scope": [
      "<unknown>"
    ],
    "2D Flat": [
      "<unknown>"
    ],
    "2D Combo": [
      "<unknown>"
    ],
    "3D Flat": [
      "<unknown>"
    ],
    "3D Scope": [
      "<unknown>"
    ],
    "3D Combo": [
      "<unknown>"
    ]
  },
  "shippingAddresses": [
    "<unknown>"
  ],
  "estimate": {
    "base": "<string>",
    "applied": "<string>"
  },
  "translation": {
    "_id": "69fbdb6c86bcded891072af6",
    "language": "BPO",
    "translator": {
      "_id": "69fbcc47695c40517b08a412",
      "emailNormal": "[e-mail]",
      "name": "Ryan Workflow",
      "groups": [
        {
          "_id": "533b8a9a55f4ba9e078b45ad",
          "name": "PPI Brazil"
        }
      ]
    },
    "status": "submitted",
    "lines": [
      "<unknown>"
    ],
    "printLines": [
      "<unknown>"
    ],
    "approval": false,
    "$links": {
      "self": "//api-staging.pixwel.com/api/Translations/69fbdb6c86bcded891072af6"
    }
  },
  "graphicsTranslation": {
    "_id": "69fbdb6c86bcded891072af5",
    "language": "BPO",
    "translator": {
      "_id": "69fbcc47695c40517b08a412",
      "emailNormal": "[e-mail]",
      "name": "Ryan Workflow",
      "groups": [
        {
          "_id": "533b8a9a55f4ba9e078b45ad",
          "name": "PPI Brazil"
        }
      ]
    },
    "status": "submitted",
    "lines": [
      {
        "number": 1,
        "text": "<div>This is test for Translations Memories</div><div>Cell 1</div>",
        "auto": false,
        "custom": true,
        "machine": false,
        "startTime": "00:00:34,743",
        "stopTime": "00:00:36,663",
        "alignment": "bottom",
        "textAlign": "center",
        "split": "<string>",
        "merged": "<string>",
        "range": [
          34.743
        ]
      }
    ],
    "printLines": [
      "<unknown>"
    ],
    "approval": false,
    "$links": {
      "self": "//api-staging.pixwel.com/api/Translations/69fbdb6c86bcded891072af5"
    }
  },
  "urls": {
    "view": "https://3x.pixwel.com/work-requests/:workRequest",
    "manage": "https://3x.pixwel.com/work-requests/:workRequest",
    "invite": "https://3x.pixwel.com/register/:code",
    "translate": "https://3x.pixwel.com/work-requests/:workRequest/subtitler"
  },
  "tags": [
    "<unknown>"
  ],
  "rejections": [
    "<unknown>"
  ],
  "files": [
    {
      "name": "attachments",
      "files": [
        "<unknown>"
      ]
    }
  ],
  "materials": [
    {
      "name": "graphics",
      "complete": false,
      "approved": false,
      "files": [
        "<unknown>"
      ]
    }
  ],
  "deliveryDeadline": {
    "date": 1778286181,
    "tz": "America/Los_Angeles"
  },
  "reason": "",
  "autoMode": false,
  "created": 1778113388,
  "$links": {
    "self": "//api-staging.pixwel.com/api/Workrequests/69fbdb6c86bcded891072af3",
    "project": "//api-staging.pixwel.com/api/Projects/regrettingyou",
    "asset": "//api-staging.pixwel.com/api/Assets/69fa4897dbab17ffa2057742",
    "from": "//api-staging.pixwel.com/api/Users/69fbcc47695c40517b08a412",
    "graphicsTranslation": "//api-staging.pixwel.com/api/Translations/69fbdb6c86bcded891072af5",
    "translation": "//api-staging.pixwel.com/api/Translations/69fbdb6c86bcded891072af6"
  },
  "encodes": [
    "<unknown>"
  ],
  "offlines": [
    "<unknown>"
  ],
  "graphicsAutomationJobs": [
    "<unknown>"
  ],
  "$statuses": [
    "awaiting-materials"
  ],
  "audioFile": "<string>"
}
EOF

200

{
  "_id": "69fbdb6c86bcded891072af3",
  "studio": "53d198844f06409d418b4571",
  "project": {
    "_id": "6865c23ca1199cff5001ec8f",
    "name": "Regretting You",
    "slug": "regrettingyou",
    "studio": "53d198844f06409d418b4571",
    "logo": "6891432c6268b8b96609b3bf",
    "$links": {
      "self": "//api-staging.pixwel.com/api/Projects/regrettingyou"
    }
  },
  "asset": {
    "_id": "69fa4897dbab17ffa2057742",
    "name": "Int'l Trailer A V2 Production",
    "slug": "intl-trailer-a-v2-production",
    "type": "preliminary-production",
    "mediaType": "video",
    "thumbnail": {
      "_id": "69fa4fc413085a78d50d4745",
      "verified": false,
      "embargo": {
        "event": false
      },
      "warnings": [
        "<unknown>"
      ],
      "mime": "image/jpeg",
      "bucket": "pixwel-slurpee2-output-staging-west-2",
      "tags": [
        "<unknown>"
      ],
      "chunkSize": 262144,
      "length": 84699,
      "md5": "ad05d0590a8d662f82b0f3dcd3fa1176",
      "uploadDate": 1778012100,
      "$links": {
        "self": "//api-staging.pixwel.com/api/Files/69fa4fc413085a78d50d4745"
      }
    },
    "transcription": {
      "graphics": "69fbd733db10562a7a02aed3"
    },
    "project": "6865c23ca1199cff5001ec8f",
    "studio": "53d198844f06409d418b4571",
    "creative": false,
    "aspectRatio": "16:9",
    "usage": {
      "broadcast": true,
      "online": true,
      "dcp": true,
      "dcp3d": true,
      "film35": false,
      "film70": false,
      "imax": true,
      "imax3d": true,
      "atmos2d": true,
      "atmos3d": true,
      "dolbyVision2d": true,
      "dolbyVision3d": true
    },
    "workflow": {
      "id": "69b0f76f1c2b56df59074142",
      "phase": "LOCK",
      "definition": {
        "phases": {
          "WIP": {
            "groups": [
              {
                "id": "533b8a8555f4baa0078b45ad",
                "dng": [
                  "<unknown>"
                ],
                "usages": [
                  "<unknown>"
                ]
              }
            ],
            "users": [
              "<unknown>"
            ],
            "terminal": false
          },
          "LOCK": {
            "groups": [
              {
                "id": "533b8a8555f4baa0078b45ad",
                "dng": [
                  "<unknown>"
                ],
                "usages": [
                  "<unknown>"
                ]
              }
            ],
            "users": [
              "<unknown>"
            ],
            "terminal": false
          },
          "FINAL": {
            "groups": [
              {
                "id": "5698315d95fa09f5738b4577",
                "dng": [
                  "graphics_Subtitled"
                ],
                "usages": [
                  "<unknown>"
                ]
              }
            ],
            "users": [
              "<unknown>"
            ],
            "terminal": true
          }
        },
        "requireGraphicsApproval": false,
        "requireOfflineApproval": false
      }
    }
  },
  "assetType": "preliminary-production",
  "assetCategory": "av",
  "auto": false,
  "autosubs": false,
  "dualLanguages": false,
  "aspectRatio": "16:9",
  "from": {
    "_id": "69fbcc47695c40517b08a412",
    "name": "Ryan Workflow",
    "emailNormal": "[e-mail]",
    "groups": [
      {
        "_id": "533b8a9a55f4ba9e078b45ad",
        "name": "PPI Brazil",
        "$links": {
          "self": "//api-staging.pixwel.com/api/Groups/533b8a9a55f4ba9e078b45ad"
        }
      }
    ]
  },
  "due": {
    "date": 1778286181,
    "tz": "America/Los_Angeles"
  },
  "language": "BPO",
  "territory": "BR",
  "dng": {
    "dialogue": [
      "Dedicated / Localized"
    ],
    "graphics": [
      "Dedicated / Localized"
    ],
    "narration": [
      "Dedicated / Localized"
    ]
  },
  "uses": {
    "items": [
      "Online"
    ],
    "details": {
      "Online": [
        {
          "value": "1080p",
          "ship": false
        }
      ]
    }
  },
  "dcp": {
    "items": [
      "<unknown>"
    ],
    "details": [
      "<unknown>"
    ]
  },
  "instructions": "",
  "status": "awaiting-materials",
  "history": [
    {
      "date": 1778113388,
      "user": {
        "_id": "69fbcc47695c40517b08a412",
        "emailNormal": "[e-mail]",
        "name": "Ryan Workflow",
        "groups": [
          {
            "_id": "533b8a9a55f4ba9e078b45ad",
            "name": "PPI Brazil"
          }
        ]
      },
      "status": "incomplete",
      "reason": ""
    }
  ],
  "recipients": {
    "Broadcast": [
      "<unknown>"
    ],
    "Dcp": [
      "<unknown>"
    ],
    "Streamingfile": [
      "<unknown>"
    ],
    "Online": [
      "<unknown>"
    ],
    "Theatrical": [
      "<unknown>"
    ],
    "Cmyk": [
      "<unknown>"
    ],
    "Rgb": [
      "<unknown>"
    ],
    "2D Scope": [
      "<unknown>"
    ],
    "2D Flat": [
      "<unknown>"
    ],
    "2D Combo": [
      "<unknown>"
    ],
    "3D Flat": [
      "<unknown>"
    ],
    "3D Scope": [
      "<unknown>"
    ],
    "3D Combo": [
      "<unknown>"
    ]
  },
  "shippingAddresses": [
    "<unknown>"
  ],
  "estimate": {
    "base": "<string>",
    "applied": "<string>"
  },
  "translation": {
    "_id": "69fbdb6c86bcded891072af6",
    "language": "BPO",
    "translator": {
      "_id": "69fbcc47695c40517b08a412",
      "emailNormal": "[e-mail]",
      "name": "Ryan Workflow",
      "groups": [
        {
          "_id": "533b8a9a55f4ba9e078b45ad",
          "name": "PPI Brazil"
        }
      ]
    },
    "status": "submitted",
    "lines": [
      "<unknown>"
    ],
    "printLines": [
      "<unknown>"
    ],
    "approval": false,
    "$links": {
      "self": "//api-staging.pixwel.com/api/Translations/69fbdb6c86bcded891072af6"
    }
  },
  "graphicsTranslation": {
    "_id": "69fbdb6c86bcded891072af5",
    "language": "BPO",
    "translator": {
      "_id": "69fbcc47695c40517b08a412",
      "emailNormal": "[e-mail]",
      "name": "Ryan Workflow",
      "groups": [
        {
          "_id": "533b8a9a55f4ba9e078b45ad",
          "name": "PPI Brazil"
        }
      ]
    },
    "status": "submitted",
    "lines": [
      {
        "number": 1,
        "text": "<div>This is test for Translations Memories</div><div>Cell 1</div>",
        "auto": false,
        "custom": true,
        "machine": false,
        "startTime": "00:00:34,743",
        "stopTime": "00:00:36,663",
        "alignment": "bottom",
        "textAlign": "center",
        "split": "<string>",
        "merged": "<string>",
        "range": [
          34.743
        ]
      }
    ],
    "printLines": [
      "<unknown>"
    ],
    "approval": false,
    "$links": {
      "self": "//api-staging.pixwel.com/api/Translations/69fbdb6c86bcded891072af5"
    }
  },
  "urls": {
    "view": "https://3x.pixwel.com/work-requests/:workRequest",
    "manage": "https://3x.pixwel.com/work-requests/:workRequest",
    "invite": "https://3x.pixwel.com/register/:code",
    "translate": "https://3x.pixwel.com/work-requests/:workRequest/subtitler"
  },
  "tags": [
    "<unknown>"
  ],
  "rejections": [
    "<unknown>"
  ],
  "files": [
    {
      "name": "attachments",
      "files": [
        "<unknown>"
      ]
    }
  ],
  "materials": [
    {
      "name": "graphics",
      "complete": false,
      "approved": false,
      "files": [
        "<unknown>"
      ]
    }
  ],
  "deliveryDeadline": {
    "date": 1778286181,
    "tz": "America/Los_Angeles"
  },
  "reason": "",
  "autoMode": false,
  "created": 1778113388,
  "$links": {
    "self": "//api-staging.pixwel.com/api/Workrequests/69fbdb6c86bcded891072af3",
    "project": "//api-staging.pixwel.com/api/Projects/regrettingyou",
    "asset": "//api-staging.pixwel.com/api/Assets/69fa4897dbab17ffa2057742",
    "from": "//api-staging.pixwel.com/api/Users/69fbcc47695c40517b08a412",
    "graphicsTranslation": "//api-staging.pixwel.com/api/Translations/69fbdb6c86bcded891072af5",
    "translation": "//api-staging.pixwel.com/api/Translations/69fbdb6c86bcded891072af6"
  },
  "encodes": [
    "<unknown>"
  ],
  "offlines": [
    "<unknown>"
  ],
  "graphicsAutomationJobs": [
    "<unknown>"
  ],
  "$statuses": [
    "awaiting-materials"
  ],
  "audioFile": "<string>"
}

Authorizations

Authorization · string · header · required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

id · string · required

Body

application/json

_id · string

Example:

"69fbdb6c86bcded891072af3"

studio · string

Example:

"53d198844f06409d418b4571"

project · object

Show child attributes

asset · object

Show child attributes

assetType · string

Example:

"preliminary-production"

assetCategory · string

Example:

"av"

auto · boolean

Example:

false

autosubs · boolean

Example:

false

dualLanguages · boolean

Example:

false

aspectRatio · string

Example:

"16:9"

from · object

Show child attributes

due · object

Show child attributes

language · string

Example:

"BPO"

territory · string

Example:

"BR"

dng · object

Show child attributes

uses · object

Show child attributes

dcp · object

Show child attributes

instructions · string

Example:

""

status · string

Example:

"awaiting-materials"

history · object[]

Show child attributes

recipients · object

Show child attributes

shippingAddresses · any[]

estimate · object

Show child attributes

translation · object

Show child attributes

graphicsTranslation · object

Show child attributes

urls · object

Show child attributes

tags · any[]

rejections · any[]

files · object[]

Show child attributes

materials · object[]

Show child attributes

deliveryDeadline · object

Show child attributes

reason · string

Example:

""

autoMode · boolean

Example:

false

created · integer

Example:

1778113388

$links · object

Show child attributes

encodes · any[]

offlines · any[]

graphicsAutomationJobs · any[]

$statuses · string[]

audioFile · string | null

Response

200 - application/json

OK

_id · string

Example:

"69fbdb6c86bcded891072af3"

studio · string

Example:

"53d198844f06409d418b4571"

project · object

Show child attributes

asset · object

Show child attributes

assetType · string

Example:

"preliminary-production"

assetCategory · string

Example:

"av"

auto · boolean

Example:

false

autosubs · boolean

Example:

false

dualLanguages · boolean

Example:

false

aspectRatio · string

Example:

"16:9"

from · object

Show child attributes

due · object

Show child attributes

language · string

Example:

"BPO"

territory · string

Example:

"BR"

dng · object

Show child attributes

uses · object

Show child attributes

dcp · object

Show child attributes

instructions · string

Example:

""

status · string

Example:

"awaiting-materials"

history · object[]

Show child attributes

recipients · object

Show child attributes

shippingAddresses · any[]

estimate · object

Show child attributes

translation · object

Show child attributes

graphicsTranslation · object

Show child attributes

urls · object

Show child attributes

tags · any[]

rejections · any[]

files · object[]

Show child attributes

materials · object[]

Show child attributes

deliveryDeadline · object

Show child attributes

reason · string

Example:

""

autoMode · boolean

Example:

false

created · integer

Example:

1778113388

$links · object

Show child attributes

encodes · any[]

offlines · any[]

graphicsAutomationJobs · any[]

$statuses · string[]

audioFile · string | null