Build

Please refer to API documentation section for the most up-to-date information
https://developer.finaleinventory.com/reference/start

Example Build:

 { "workEffortId":"100000",
  "workEffortUrl":"/demo/api/workeffort/100000",
  "workEffortTypeId":"PROD_ORDER_TASK",
  "statusId":"PRUN_CREATED",
  "actionUrlCancel":"/demo/api/workeffort/100000/cancel",
  "actionUrlStart":"/demo/api/workeffort/100000/start",
  "actionUrlComplete":"/demo/api/workeffort/100000/complete",
  "facilityUrl":"/demo/api/facility/100002",
  "startDateEstimated":"2019-07-25T19:00:00",
  "completeDateEstimated":"2019-07-25T19:00:00",
  "productIdToProduce":"100004",
  "productUrlToProduce":"/demo/api/product/100004",
  "quantityToProduce":1,
  "lastUpdatedDate":"2019-07-25T19:13:45",
  "createdDate":"2019-07-25T19:12:08",
  "workEffortConsumeList":[
    { "facilityUrl":"/demo/api/facility/100002",
      "productId":"100002",
      "productUrl":"/demo/api/product/100002",
      "quantity":2},
    { "facilityUrl":"/demo/api/facility/100002",
      "productId":"100003",
      "productUrl":"/demo/api/product/100003",
      "quantity":1}],
  "workEffortProduceList":[
    { "facilityUrl":"/demo/api/facility/100002",
      "productId":"100004",
      "productUrl":"/demo/api/product/100004",
      "quantity":1}],
  "statusIdHistoryList":[
    { "statusId":null,
      "txStamp":1564081928,
      "userLoginUrl":"/demo/api/userlogin/test"},
    { "statusId":null,"txStamp":1564082025,
      "userLoginUrl":"/demo/api/userlogin/test"}],
  "invalidations":["/demo/api/workeffort/"]
}

• Fields for the build resource.
  - actionUrlCancel
  POST to this URL with an empty body to change status to `PRUN_CANCELLED` which corresponds to the status of cancelled in the user interface. Builds in the cancelled state can not be modified.
  - actionUrlStart
  POST to this URL with startDate in the body to change status to `PRUN_STARTED` which corresponds to the status of started in the user interface.
  - actionUrlComplete
  POST to this URL with completeDate in the body to change status to `PRUN_COMPLETED` which corresponds to the status of completed in the user interface. Builds in the completed state can not be modified.
  - completeDate
  Timestamp for the estimated complete data for the build. Only set when posting to the actionUrlComplete endpoint.
  - completeDateEstimated
  Timestamp for the estimated complete data for the build.
  - createdDate
  Timestamp for when the build was created. Set automatically by the server. Read only.
  - description
  Description field from the user interface.
  - facilityUrl
  References the destination Sublocation. Required field
  - invalidations
  Used internally. Read only
  - lastUpdatedDate
  Timestamp for when the build was last updated. Set automatically by the server. Read only.
  - productIdToProduce
  The identifier shown in the UI for the product to produce. Read only.
  - productUrlToProduce
  Reference to the product to produce. Should be the same as value in the workEffortProduceList.
  - quantityToProduce
  The quantity of the product to produce. Should be the same as the value in the workEffortProduceList.
  - startDate
  Timestamp for the actual start date for the build. Only set when posting to the actionUrlStart endpoint.
  - startDateEstimated
  Timestamp for the estimated start date for the build.
  - statusId
  One of the values `PRUN_CREATED`, `PRUN_STARTED`, `PRUN_COMPLETED`, or `PRUN_CANCELLED`. Read only.
  - statusIdHistoryList
  Array representing the history of edits to a build. Read only.
  Each has the following fields:
  - **statusId** The new statusId value if changed. If status is unchanged, it will be null.
  - **txStamp** When the change occurred represented as a timestamp in seconds.
  - **userLoginUrl** Reference to the user who made the change.
  - workEffortConsumeList
  Array representing the products consumed by the build, each having one or more of the following fields:
  - **facilityUrl** Reference to the source sublocation for the product.
  - **productId** The identifier shown in the UI for the product. Read only.
  - **productUrl** Reference to the product to consume. Use this value when setting which product should be consumed.
  - **quantity** Floating point value. Read only after build is started.
  - **normalizedPackingString** Packing for the item (see [patterns]( Resource-Pattern ) for description of this data type).
  - workEffortId
  The unique ID for the work effort. Can be set when the work effort is first created, and after that is read only. Limited to 20 ASCII characters
  - workEffortProduceList
  Array representing the products produced by the build, each having one or more of the following fields:
  - **facilityUrl** Reference to the destination sublocation for the product.
  - **productId** The identifier shown in the UI for the product. Read only.
  - **productUrl** Reference to the product to produce. Use this value when setting which product should be produced.
  - **quantity** Floating point value. Read only after build is started.
  - **normalizedPackingString** Packing for the item (see [patterns]( Resource-Pattern) for description of this data type).
  - workEffortTypeId
  This is always set to PROD_ORDER_TASK which means it's a production run task. In the future this may take on other values to represent projects, production runs, etc.
  - workEffortUrl
  The unique identifier for the order. Read only.

• Back to top