Skip to content

Release 1.26/27

New Endpoints: 1

GET /ProdOrder/{prodOrderId}  

Deleted Endpoints: None

Modified Endpoints: 9

POST /BTLx

  • Description changed from 'Posting a BTLx file to Optinex is considered an asynchronous operation.

Recieving a 202 Accepted means that Optinex has recieved the file and is stored for further processing,

it may take additional time before it is visible and/or available elsewhere in Optinex, returning 202 is intended

to give back control to the caller that the file has been accepted and is being processed.' to 'Posting a BTLx file to Optinex is considered an asynchronous operation.

Recieving a 202 Accepted means that Optinex has recieved the file and is stored for further processing,

it may take additional time before it is visible and/or available elsewhere in Optinex, returning 202 is intended

to give back control to the caller that the file has been accepted and is being processed.'

  • Responses changed

- Modified response: 202

- Description changed from 'Returns 202, meaning the request has been accepted.

This means that the file exists in Optinex and is tagged for further asynchronous processing' to 'Returns 202, meaning the request has been accepted.

This means that the file exists in Optinex and is tagged for further asynchronous processing'

POST /Demand

PUT /Demand/{orderID}/{orderRowID}

PUT /Demand/{siteCode}/{orderID}/{orderRowID}

GET /GluPlan

  • New query param: siteCode

PUT /ProdOrder

  • Description changed from 'Allows updates on production orders in Optinex. This endpoint can be used to link your external production order id to our internal id, to do this send in both ids.' to 'In this API, you may update an existing Production Order and its associated lines in Optinex.

This API cannot create new Production Orders or lines; it is solely for updating existing ones.'

POST /ProdOrderReport

POST /entities

PUT /entities

Other Changes

Extensions changed

  • Modified extension: host

- Modified value from 'fxoptinex-func-prod.azurewebsites.net' to 'fxoptinex-func-test.azurewebsites.net'

  • Modified extension: definitions

- Modified /demandReciveDTO/example from '{"beamOrderRowID":123,"orderID":"Order123","species":null,"orderRowID":"OrderRow123","plannedProductionDate":null,"millExitDate":null,"latestProductionDate":"0001-01-01T00:00:00","customerDesc":null,"qty":0.0,"qtyUnit":null,"width":0.0,"hight":0.0,"length":0.0,"isPlanable":true,"isActive":true,"demandValue":0.0,"entityGroupCode":null,"externalItemID":null,"constructionCertification":null,"materialIndex":null,"volume":null,"propertys":[],"transportPackageAllocations":[],"orderComment":null,"orderRowComment":null,"customerNo":null,"pickingInst":null,"demandType":null,"siteCode":null,"lamellaPlaningThickness":null,"rawLamellaThickness":null,"trimmingLocation":null,"isSpecialFormBeam":false,"specialFormName":null,"beamIconId":null,"radius":null,"lamellaSpecs":[],"pressframeSpec":null,"planningType":0,"visualQuality":null,"planeProfile":null,"mainProduct":null,"externalPositionNumber":null,"externalBeamMaterialTypeId":null,"rawLamellaWidth":null,"profileCode":null,"profileLayers":null,"allowedVolumeDeviation":false}' to '{"beamOrderRowID":123,"orderID":"Order123","species":null,"orderRowID":"OrderRow123","plannedProductionDate":null,"millExitDate":null,"latestProductionDate":"0001-01-01T00:00:00","customerDesc":null,"qty":0.0,"qtyUnit":null,"width":0.0,"hight":0.0,"length":0.0,"isPlanable":true,"isActive":true,"demandValue":0.0,"entityGroupCode":null,"externalItemID":null,"constructionCertification":null,"materialIndex":null,"volume":null,"requiresDimensionalAccuracy":true,"propertys":[],"transportPackageAllocations":[],"orderComment":null,"orderRowComment":null,"customerNo":null,"pickingInst":null,"demandType":null,"siteCode":null,"lamellaPlaningThickness":null,"rawLamellaThickness":null,"trimmingLocation":null,"isSpecialFormBeam":false,"specialFormName":null,"beamIconId":null,"radius":null,"lamellaSpecs":[],"pressframeSpec":null,"planningType":0,"visualQuality":null,"planeProfile":null,"mainProduct":null,"externalPositionNumber":null,"externalBeamMaterialTypeId":null,"rawLamellaWidth":null,"profileCode":null,"profileLayers":null,"allowedUnderProduction":false,"deliveryTolerance":0.0,"fulfillmentTolerance":0.0,"lengthRestrictions":[{"minLength":4000,"maxLength":4500,"fraction":22.8,"isFairSpread":false,"comment":""},{"minLength":4501,"maxLength":5200,"fraction":77.2,"isFairSpread":false,"comment":""}]}'

- Added /demandReciveDTO/properties/allowedUnderProduction with value: 'map[description:Allowed Under Production type:boolean]'

- Removed /demandReciveDTO/properties/allowedVolumeDeviation with value: 'map[type:boolean]'

- Added /demandReciveDTO/properties/deliveryTolerance with value: 'map[description:Allowed quantity tolerance format:double type:number]'

- Added /demandReciveDTO/properties/fulfillmentTolerance with value: 'map[description:Allowed quantity tolerance for closing of demand format:double type:number]'

- Added /demandReciveDTO/properties/lengthRestrictions with value: 'map[description:Length Distributions to impose on demand. For example to represent a structure of 50% of qty spans the lengths 4000-4500; and 25% spans 4501-5000; and 25% 5001-6000 items:map[$ref:#/definitions/lengthRestrictionDTO] type:array]'

- Added /demandReciveDTO/properties/requiresDimensionalAccuracy with value: 'map[description:Indicates whether to use planing oversize (height). Defaults false when omitted. type:boolean]'

- Added /demandResponceDTO/properties/allowedUnderProduction with value: 'map[type:boolean]'

- Removed /demandResponceDTO/properties/allowedVolumeDeviation with value: 'map[type:boolean]'

- Added /entityExternalDTO/properties/status with value: 'map[description:Status representing the status of the entity we can use below items to send status /n 'Active','InActive','Preliminary','Archived' type:string]'

- Modified /entityUpdateInboundDTO/example from '{"code":"ENT12345","externalId":"EXT67890"}' to '{"code":"ENT12345","externalId":"EXT67890","status":null}'

- Removed /entityUpdateInboundDTO/properties/externalId/minLength with value: '1'

- Added /entityUpdateInboundDTO/properties/status with value: 'map[description:New status of the entity. If omitted, entity remains in same status. If passed, allowed values: Active, InActive, Preliminary, Archived. type:string]'

- Removed /entityUpdateInboundDTO/required/1 with value: 'externalId'

- Added /getProdOrderLineResponseDTO with value: 'map[properties:map[additionalInstructions:map[items:map[$ref:#/definitions/prodOrderAdditionalInstructionsResponseDTO] type:array] batches:map[items:map[$ref:#/definitions/prodOrderLineBatchResponseDTO] type:array] direction:map[type:string] isEmptyStock:map[type:string] mainReportingLine:map[type:string] materialCode:map[type:string] materialDescription:map[type:string] planedQty:map[format:double type:number] planedQtyUOM:map[type:string] plannedLength:map[format:double type:number] plannedQuality:map[type:string] plannedThickness:map[format:double type:number] plannedWidth:map[format:double type:number] prodOrderGuid:map[format:uuid type:string] prodOrderID:map[format:int32 type:integer] prodOrderLineId:map[format:int32 type:integer] prodOrderReport:map[items:map[$ref:#/definitions/prodOrderReportResponseDTO] type:array] stockLocationId:map[format:int32 type:integer] stockLocationName:map[type:string] totalReportedQty:map[format:double type:number]] type:object]'

- Added /getProdOrderResponseDTO with value: 'map[properties:map[actualExecutionDuration:map[format:int32 type:integer] actualExecutionEndDate:map[format:date-time type:string] actualExecutionStartDate:map[format:date-time type:string] demandId:map[format:int32 type:integer] dependsOfId:map[format:int32 type:integer] dependsOnId:map[format:int32 type:integer] externalProdOrderID:map[type:string] instruction:map[type:string] instructions:map[items:map[$ref:#/definitions/prodOrderInstructionResponseDTO] type:array] machineId:map[format:int32 type:integer] machineName:map[type:string] name:map[type:string] operatorComment:map[type:string] orderNo:map[type:string] orderRowNo:map[type:string] plannedExecutionDuration:map[format:int32 type:integer] plannedExecutionEndDate:map[format:date-time type:string] plannedExecutionStartDate:map[format:date-time type:string] prodOrderId:map[format:int32 type:integer] prodOrderLines:map[items:map[$ref:#/definitions/getProdOrderLineResponseDTO] type:array] state:map[type:string]] type:object]'

- Added /lengthRestrictionDTO with value: 'map[example:{"minLength":2400,"maxLength":6000,"fraction":23.1,"isFairSpread":true,"comment":""} properties:map[comment:map[description:An optional comment or note about the length restriction. Truncates to maximum 50 characters. type:string] fraction:map[description:The fraction value used for length distribution calculations represented in per-centage with one decimal accuracy. Valid range: 0.1 - 100.0 format:double maximum:100 minimum:0.1 type:number] isFairSpread:map[description:Indicates whether fair spread distribution should be applied across lengths. Defaults to false if omitted. type:boolean] maxLength:map[description:The maximum allowed length in millimeters format:int32 maximum:2.147483647e+09 minimum:0 type:integer] minLength:map[description:The minimum allowed length in millimeters format:int32 maximum:2.147483647e+09 minimum:0 type:integer]] required:[minLength maxLength fraction isFairSpread] type:object]'

- Added /prodOrderInstructionResponseDTO with value: 'map[properties:map[code:map[type:string] description:map[type:string] name:map[type:string] value:map[type:string]] type:object]'

- Added /prodOrderLineBatchInstructionResponseDTO with value: 'map[properties:map[code:map[type:string] description:map[type:string] name:map[type:string] value:map[type:string]] type:object]'

- Added /prodOrderLineBatchResponseDTO with value: 'map[properties:map[instructions:map[items:map[$ref:#/definitions/prodOrderLineBatchInstructionResponseDTO] type:array] length:map[format:double type:number] prodOrderLineBatchId:map[format:uuid type:string] psc:map[format:int32 type:integer] qty:map[format:double type:number] qtyUnit:map[type:string] quality:map[type:string] sortOrder:map[format:int32 type:integer] thickness:map[format:double type:number] width:map[format:double type:number]] type:object]'

- Added /prodOrderReportDTO/example with value: '{"siteCode":"SITE_01","productionOrderId":123,"externalProdOrderId":"EXT_123","state":1,"operatorComment":"Started production","actualStartDate":"2024-01-01T09:00:00","actualEndDate":"2024-01-01T10:00:00","isPartial":false,"duration":60,"lines":[{"productionOrderReportID":null,"prodOrderLineGuid":"dd840e07-aef6-4096-8d1f-b3ae6fdf119b","prodOrderLineID":null,"handelingUnitIdentifier":null,"materialCode":"MAT_001","length":1000.0,"width":500.0,"quality":"A","visualQuality":"H1","thickness":10.0,"reportedQty":5.0,"reportedQtyUOM":"PCS","eventDate":"2024-01-01T09:30:00","reportData":null,"message":null,"stockLocationCode":"LOC_01","prodOrderLineNumberGlobal":1}]}'

- Added /prodOrderReportDTO/properties/duration with value: 'map[description:Duration, if provided use this otherwise calculate duration format:int32 type:integer]'

- Added /prodOrderReportDTO/properties/state/enum/- with value: '10'

- Added /updateProdOrderLineDTO with value: 'map[properties:map[actualEnd:map[description:Actual end time of the production order line. If omitted, does not change. format:date-time type:string] actualStart:map[description:Planned end time of the production order line. If omitted, does not change. format:date-time type:string] externalId:map[description:Your external Id for the production order line. Once set, can never be changed. type:string] machineCode:map[description:Code of Machine. If omitted, does not change. type:string] plannedStart:map[description:Planned start time of the production order line. If omitted, does not change. format:date-time type:string] prodOrderLineId:map[description:The Id of the production order line format:uuid type:string] prodOrderLineNumber:map[format:int32 type:integer] state:map[description:Status of the production order line. If omitted, does not change. If used, allowed values: Preview, Planned, Released, Started, Stopped, Reported, Completed, Closed, Archived. type:string]] type:object]'

- Added /updateProdOrderRequestDTO/properties/actualEnd with value: 'map[description:Actual End time of the production order. If omitted, does not change. format:date-time type:string]'

- Added /updateProdOrderRequestDTO/properties/actualStart with value: 'map[description:Actual start time of the production order. If omitted, does not change. format:date-time type:string]'

- Modified /updateProdOrderRequestDTO/properties/externalProdOrderId/description from 'Your external production order Id' to 'Your external production order Id. Once externalId is set it can never change.'

- Added /updateProdOrderRequestDTO/properties/plannedStart with value: 'map[description:Planned start time of the production order. If omitted, does not change. format:date-time type:string]'

- Modified /updateProdOrderRequestDTO/properties/prodOrderId/description from 'The Id of the production order' to 'Production order Id'

- Modified /updateProdOrderRequestDTO/properties/prodOrderId/format from 'int32' to 'uuid'

- Modified /updateProdOrderRequestDTO/properties/prodOrderId/type from 'integer' to 'string'

- Added /updateProdOrderRequestDTO/properties/prodOrderLines with value: 'map[description:The lines to update. This API cannot create new lines. items:map[$ref:#/definitions/updateProdOrderLineDTO] type:array]'

- Added /updateProdOrderRequestDTO/properties/prodOrderNumberGlobal with value: 'map[description:Legacy identifier for production order format:int32 type:integer]'

- Added /updateProdOrderRequestDTO/properties/state with value: 'map[description:State of the production order. If omitted, does not change. If used, allowed values: Preview, Planned, Released, Started, Stopped, Reported, Completed, Closed, Archived, Cancelled. type:string]'