{
"_type": "export",
"__export_format": 4,
"__export_source": "sap-dmc-api-generator",
"resources": [
{
"_id": "req_363edd3a8de44838a8436f31",
"_type": "workspace",
"name": "SAP Digital Manufacturing Cloud APIs",
"description": "Auto-generated workspace of all SAP DMC REST APIs.",
"scope": "collection",
"parentId": null
},
{
"_id": "req_378c249083df4aa7b8b77c43",
"_type": "environment",
"name": "Base Environment",
"parentId": "req_363edd3a8de44838a8436f31",
"data": {
"base_url": "https://test.eu10.dmc.cloud.sap",
"token": ""
}
},
{
"_id": "req_4ff55245eb3e4d48975e1579",
"_type": "request_group",
"name": "Activity Confirmation",
"description": "Post Activity confirmations",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_93ac645702c142bbaf018672",
"_type": "request",
"name": "Post activity confirmations.",
"description": "Post activity confirmations for an operation activity, Sfc, order executed at a given workcenter and plant.",
"method": "POST",
"url": "{{ _.base_url }}/confirm",
"parentId": "req_4ff55245eb3e4d48975e1579",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"activities\": [\n {\n \"activityId\": \"string\",\n \"postedBy\": \"string\",\n \"postingDateTime\": \"2024-01-01T00:00:00Z\",\n \"quantity\": 0.0\n }\n ],\n \"operationActivity\": \"string\",\n \"plant\": \"string\",\n \"shopOrder\": \"string\",\n \"stepId\": \"string\",\n \"workCenter\": \"string\"\n}"
}
},
{
"_id": "req_edbbb04779de42e590c736c1",
"_type": "request",
"name": "Confirms activities automatically.",
"description": "Confirms activities for the parameters provided as input by automatically calculating the standard values. The standard values are calculated based on the elapsed operation time, on a simple prorated basis.",
"method": "POST",
"url": "{{ _.base_url }}/autoconfirm",
"parentId": "req_4ff55245eb3e4d48975e1579",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"operationActivity\": \"string\",\n \"operationActivityVersion\": \"string\",\n \"plant\": \"string\",\n \"postedBy\": \"string\",\n \"postingDateTime\": \"2024-01-01T00:00:00Z\",\n \"resource\": \"string\",\n \"routingId\": \"string\",\n \"sfc\": \"string\",\n \"shopOrder\": \"string\",\n \"stepId\": \"string\",\n \"workCenter\": \"string\"\n}"
}
},
{
"_id": "req_7c4f7b0e78f840ca989ac827",
"_type": "request",
"name": "Retrieves activity confirmation posting.",
"description": "Retreives the activity confirmation posting summary for the specified operation activity.",
"method": "GET",
"url": "{{ _.base_url }}/postings/summary",
"parentId": "req_4ff55245eb3e4d48975e1579",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "Plant where activity confirmation has to be performed.",
"disabled": false
},
{
"name": "shopOrder",
"value": "",
"description": "Shop order for which activity confirmation has to be performed.",
"disabled": false
},
{
"name": "sfc",
"value": "",
"description": "Sfc of the order for which activity confirmation has to be performed. If the shop order has only one Sfc, this attribute is optional. Else, provide the Sfc.",
"disabled": false
},
{
"name": "operationActivity",
"value": "",
"description": "Operation activity at which activity confirmation has to be performed.",
"disabled": false
},
{
"name": "stepId",
"value": "",
"description": "Step Identifier at which activity confirmation has to be performed.",
"disabled": false
},
{
"name": "workCenter",
"value": "",
"description": "Work center at which activity confirmation has to be performed.",
"disabled": false
}
],
"authentication": {}
},
{
"_id": "req_0688e0741f0041579bd22b69",
"_type": "request",
"name": "Retrieves activity confirmation posting details.",
"description": "Retrieves the activity confirmation posting details for the specified SFC and plant. By default, the activity confirmation posting details are sorted by CreatedAt in descending order.",
"method": "GET",
"url": "{{ _.base_url }}/postings/details",
"parentId": "req_4ff55245eb3e4d48975e1579",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "Plant where activity confirmation has to be performed.",
"disabled": false
},
{
"name": "sfc",
"value": "",
"description": "SFC of the order for which activity confirmation has to be performed.",
"disabled": false
},
{
"name": "operationActivity",
"value": "",
"description": "Operation activity at which activity confirmation has to be performed.",
"disabled": true
},
{
"name": "stepId",
"value": "",
"description": "Step identifier at which activity confirmation has to be performed.",
"disabled": true
},
{
"name": "activityId",
"value": "",
"description": "Activity identifier at which activity confirmation has to be performed.",
"disabled": true
},
{
"name": "page",
"value": "",
"description": "Page index (starts from 0), default is 0.",
"disabled": true
},
{
"name": "size",
"value": "",
"description": "The size of the page, default is 20.",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_fb47ee6bb631421aac305149",
"_type": "request_group",
"name": "Alert Management",
"description": "Create or update alerts in SAP Digital Manufacturing",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_4038ff058055434b971e3955",
"_type": "request",
"name": "Retrieve a list of alerts.",
"description": "Retrieve a list of alerts based on the provided filter criteria. Alerts can be retrieved by their properties, such as alert type, severity, status, as well as other fields specific to the alert type's defined alert data schemas when the Alert-Type header is set.",
"method": "GET",
"url": "{{ _.base_url }}/v1/Alerts",
"parentId": "req_fb47ee6bb631421aac305149",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
},
{
"name": "Alert-Type",
"value": "",
"description": "The Alert-Type request HTTP header is used to specify the alert type of the alert, as configured in the Manage Alert Configurations application."
}
],
"parameters": [
{
"name": "$filter",
"value": "",
"description": "Filter items by property values. For more information, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
"disabled": true
},
{
"name": "$orderby",
"value": "",
"description": "Order items by property values. For more information, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
"disabled": true
},
{
"name": "$select",
"value": "",
"description": "Select properties to be returned. For more information, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"disabled": true
},
{
"name": "$expand",
"value": "",
"description": "The value of $expand query option is a comma-separated list of navigation property names, stream property names, or $value indicating the stream content of a media-entity. The corresponding related entities and stream values will be represented inline. For more information, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_aa0da52816044af3ab10f290",
"_type": "request",
"name": "Create a new alert",
"description": "Create a new alert",
"method": "POST",
"url": "{{ _.base_url }}/v1/Alerts",
"parentId": "req_fb47ee6bb631421aac305149",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
},
{
"name": "Alert-Type",
"value": "",
"description": "The Alert-Type request HTTP header is used to specify the alert type of the alert, as configured in the Manage Alert Configurations application."
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"AlertType\": \"string\",\n \"Severity\": \"string\",\n \"Status\": \"string\",\n \"TriggeredOn\": \"string\"\n}"
}
},
{
"_id": "req_d01351ea26e94890bfc34070",
"_type": "request",
"name": "Update an existing alert",
"description": "Update an existing alert",
"method": "PATCH",
"url": "{{ _.base_url }}/v1/Alerts({id})",
"parentId": "req_fb47ee6bb631421aac305149",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
},
{
"name": "Alert-Type",
"value": "",
"description": "The Alert-Type request HTTP header is used to specify the alert type of the alert, as configured in the Manage Alert Configurations application."
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"ExternalId\": \"string\",\n \"Info\": \"string\",\n \"Processor\": {\n \"FirstName\": \"string\",\n \"Id\": \"string\",\n \"LastName\": \"string\"\n },\n \"Processors\": [\n {\n \"FirstName\": \"string\",\n \"Id\": \"string\",\n \"LastName\": \"string\"\n }\n ],\n \"Severity\": \"string\",\n \"Status\": \"string\"\n}"
}
},
{
"_id": "req_d1368646534c4858a48cf5b3",
"_type": "request_group",
"name": "Artificial Intelligence and Machine Learning Scenarios",
"description": "Manage Artificial Intelligence and Machine Learning Scenarios for automation of manufacturing processes",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_6eebffd1bb0a424692f8715a",
"_type": "request",
"name": "Retrieves the active AI/ML scenarios.",
"description": "Retrieves the active AI/ML scenarios for provided input.",
"method": "GET",
"url": "{{ _.base_url }}/active-scenarios",
"parentId": "req_d1368646534c4858a48cf5b3",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "deploymentType",
"value": "",
"description": "The consuming application where AI/ML models need to be deployed.",
"disabled": true
},
{
"name": "material",
"value": "",
"description": "Material for retrieving AI/ML scenarios.",
"disabled": true
},
{
"name": "operation",
"value": "",
"description": "Operation for retrieving AI/ML scenarios.",
"disabled": true
},
{
"name": "plant",
"value": "",
"description": "Plant for retrieving AI/ML scenarios.",
"disabled": true
},
{
"name": "resource",
"value": "",
"description": "Resource for retrieving AI/ML scenarios.",
"disabled": true
},
{
"name": "routing",
"value": "",
"description": "Routing for retrieving AI/ML scenarios.",
"disabled": true
},
{
"name": "sfc",
"value": "",
"description": "SFC for retrieving AI/ML scenarios.",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_ff86fc2f00b440ada65c6e0f",
"_type": "request",
"name": "Download a file uploaded for an AI/ML scenario.",
"description": "Download a file uploaded for an AI/ML scenario for a given scenario id and version.",
"method": "GET",
"url": "{{ _.base_url }}/scenario/{id}/version/{version}/file/{fileName}",
"parentId": "req_d1368646534c4858a48cf5b3",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {}
},
{
"_id": "req_3540be5fd11d4c3c963ae451",
"_type": "request",
"name": "Provides all the inspection logs for a SFC.",
"description": "Provides all the inspection logs (images, predictions, and operator actions) for a SFC.",
"method": "GET",
"url": "{{ _.base_url }}/inspectionLog",
"parentId": "req_d1368646534c4858a48cf5b3",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "fileID",
"value": "",
"description": "File ID.",
"disabled": true
},
{
"name": "fromDate",
"value": "",
"description": "From date time.",
"disabled": true
},
{
"name": "toDate",
"value": "",
"description": "To date time.",
"disabled": true
},
{
"name": "inspectionViewName",
"value": "",
"description": "Inspection View identifier.",
"disabled": true
},
{
"name": "loggedNCCode",
"value": "",
"description": "Logged NC Code",
"disabled": true
},
{
"name": "material",
"value": "",
"description": "Material name.",
"disabled": true
},
{
"name": "operation",
"value": "",
"description": "Operation Activity name.",
"disabled": true
},
{
"name": "plant",
"value": "",
"description": "Plant name.",
"disabled": false
},
{
"name": "resource",
"value": "",
"description": "Resource name.",
"disabled": true
},
{
"name": "routing",
"value": "",
"description": "Routing name.",
"disabled": true
},
{
"name": "scenarioID",
"value": "",
"description": "AI/ML Scenario ID",
"disabled": true
},
{
"name": "scenarioVersion",
"value": "",
"description": "AI/ML Scenario version",
"disabled": true
},
{
"name": "sfc",
"value": "",
"description": "Shop Floor Control identifier.",
"disabled": true
},
{
"name": "source",
"value": "",
"description": "Source of production data.",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_5653b00356f74af790f70d86",
"_type": "request",
"name": "Creates inspection log for a Shop Floor Control (SFC).",
"description": "Logs the image of the SFC, predictions by the AI/ML model and operations( Log NCS and mark as conformant/ nonconformant ) performed by the operator.",
"method": "POST",
"url": "{{ _.base_url }}/inspectionLog",
"parentId": "req_d1368646534c4858a48cf5b3",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"context\": {\n \"inspectionViewName\": \"string\",\n \"material\": \"string\",\n \"operation\": \"string\",\n \"plant\": \"string\",\n \"resource\": \"string\",\n \"routing\": \"string\",\n \"sfc\": \"string\",\n \"source\": \"string\"\n }\n}"
}
},
{
"_id": "req_95edaf51912540bc9f0e3c10",
"_type": "request",
"name": "Gets all the inspection logs for an AI/ML scenario.",
"description": "Provides all the inspection logs (images, predictions, and operator actions) for a SFC.",
"method": "GET",
"url": "{{ _.base_url }}/aiml/v1/inspectionLogsForContext",
"parentId": "req_d1368646534c4858a48cf5b3",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "fileID",
"value": "",
"description": "File ID",
"disabled": true
},
{
"name": "fromDate",
"value": "",
"description": "From date.",
"disabled": true
},
{
"name": "toDate",
"value": "",
"description": "To date.",
"disabled": true
},
{
"name": "inspectionViewName",
"value": "",
"description": "Inspection View identifier.",
"disabled": true
},
{
"name": "loggedNCCode",
"value": "",
"description": "Logged NC Code.",
"disabled": true
},
{
"name": "material",
"value": "",
"description": "Material name.",
"disabled": true
},
{
"name": "operation",
"value": "",
"description": "Operation Activity name.",
"disabled": true
},
{
"name": "plant",
"value": "",
"description": "Plant name.",
"disabled": false
},
{
"name": "resource",
"value": "",
"description": "Resource name.",
"disabled": true
},
{
"name": "routing",
"value": "",
"description": "Routing name.",
"disabled": true
},
{
"name": "scenarioID",
"value": "",
"description": "AI/ML Scenario ID.",
"disabled": true
},
{
"name": "scenarioVersion",
"value": "",
"description": "AI/ML Scenario version.",
"disabled": true
},
{
"name": "sfc",
"value": "",
"description": "Shop Floor Control identifier.",
"disabled": true
},
{
"name": "skip",
"value": "",
"description": "skip.",
"disabled": true
},
{
"name": "source",
"value": "",
"description": "Source of production data.",
"disabled": true
},
{
"name": "top",
"value": "",
"description": "top",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_c052824966614f86a85fffcc",
"_type": "request_group",
"name": "Assembly",
"description": "View components for assembly, assemble and remove components",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_729f3a46c8d6417d90907d6e",
"_type": "request",
"name": "Retrieves the planned component list.",
"description": "Retrieves list of all the planned BOM components which can be assembled for the given SFC and operation activity.",
"method": "GET",
"url": "{{ _.base_url }}/plannedComponents",
"parentId": "req_c052824966614f86a85fffcc",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "Plant for retrieving list of components to be assembled.",
"disabled": false
},
{
"name": "sfc",
"value": "",
"description": "SFC for retrieving list of components to be assembled.",
"disabled": false
},
{
"name": "operationActivity",
"value": "",
"description": "Operation activities in comma-separated way for retrieving list of components to be assembled.",
"disabled": true
},
{
"name": "assemblyDataTypes",
"value": "",
"description": "Name of the assembly data types in comma-separated way for retrieving list of components to be assembled.",
"disabled": true
},
{
"name": "requireCustomData",
"value": "",
"description": "The flag to indicate if, the custom data needs to be included in the response.",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_a90dc55839744d79bcbca18d",
"_type": "request",
"name": "Auto assembles components.",
"description": "Auto assembles components on the given operation and resource.",
"method": "POST",
"url": "{{ _.base_url }}/autoAssemble",
"parentId": "req_c052824966614f86a85fffcc",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"operationActivity\": \"string\",\n \"plant\": \"string\",\n \"resource\": \"string\",\n \"sfcs\": [\n \"string\"\n ]\n}"
}
},
{
"_id": "req_f443ed1fd9ca4f7da84716d2",
"_type": "request",
"name": "Checks the resource bin component quantity.",
"description": "Checks the resource bin component quantity is enough to make time based auto assembly.",
"method": "POST",
"url": "{{ _.base_url }}/components/quantity/check",
"parentId": "req_c052824966614f86a85fffcc",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"operation\": \"string\",\n \"operationVersion\": \"string\",\n \"plant\": \"string\",\n \"resource\": \"string\",\n \"sfcs\": [\n \"string\"\n ]\n}"
}
},
{
"_id": "req_1bd24315f5c04396a55de099",
"_type": "request",
"name": "Retrieves the components already assembled.",
"description": "Returns the components already assembled with data collected during assembly.",
"method": "GET",
"url": "{{ _.base_url }}/assembledComponents",
"parentId": "req_c052824966614f86a85fffcc",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "Plant for retrieving list of assembled components.",
"disabled": false
},
{
"name": "sfc",
"value": "",
"description": "SFC for retrieving list of assembled components.",
"disabled": false
},
{
"name": "operationActivity",
"value": "",
"description": "Operation activity for retrieving list of assembled components.",
"disabled": false
},
{
"name": "assemblyDataTypes",
"value": "",
"description": "Name of the assembly data types in comma-separated way for retrieving list of components to be assembled.",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_f7e1956c3cf74cf3974ba2bb",
"_type": "request",
"name": "Adds a component.",
"description": "Assembles planned BOM component.",
"method": "POST",
"url": "{{ _.base_url }}/assembledComponents",
"parentId": "req_c052824966614f86a85fffcc",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"component\": \"string\",\n \"componentVersion\": \"string\",\n \"operationActivity\": \"string\",\n \"plant\": \"string\",\n \"quantity\": 0.0,\n \"resource\": \"string\",\n \"sfc\": \"string\"\n}"
}
},
{
"_id": "req_419fb09bdac34b3399a4be2c",
"_type": "request",
"name": "Removes a component.",
"description": "Removes assembled BOM component.",
"method": "DELETE",
"url": "{{ _.base_url }}/assembledComponents",
"parentId": "req_c052824966614f86a85fffcc",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {}
},
{
"_id": "req_6f379a87792a4b0faddb6910",
"_type": "request",
"name": "Checks assembled components.",
"description": "Checks if components are assembled according to predefined rules for the SFCs.",
"method": "POST",
"url": "{{ _.base_url }}/checkComponents",
"parentId": "req_c052824966614f86a85fffcc",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"operation\": \"string\",\n \"plant\": \"string\",\n \"sfcs\": [\n \"string\"\n ]\n}"
}
},
{
"_id": "req_bb2bd4e4aee444d9a37ed055",
"_type": "request",
"name": "Saves as-built information via file upload.",
"description": "Saves the as-built information from the uploaded file in a service order SFC.",
"method": "POST",
"url": "{{ _.base_url }}/serviceOrder/asBuilt/upload",
"parentId": "req_c052824966614f86a85fffcc",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "sfc",
"value": "",
"description": "The SFC for which the as-built information is saved.",
"disabled": false
},
{
"name": "plant",
"value": "",
"description": "The plant for which the as-built information is saved.",
"disabled": false
}
],
"authentication": {}
},
{
"_id": "req_b7c7e84926a44104beec61b4",
"_type": "request_group",
"name": "Asset Model",
"description": "Retrieves metadata of an asset.",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_977f6b05b19042c8b7464a8f",
"_type": "request",
"name": "Retrieves metadata of an asset",
"description": "Retrieves metadata of an asset with specific identifier. Metadata comprises of entities such as asset type, structure, indicator, attribute, and codelist.",
"method": "GET",
"url": "{{ _.base_url }}/assets/{assetId}/metadata",
"parentId": "req_b7c7e84926a44104beec61b4",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {}
},
{
"_id": "req_fde53a4a59e2495fb773bb87",
"_type": "request_group",
"name": "Batch",
"description": "Create batches and retrieve batch characteristics, update or sync batch information",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_308289460b884ddfbaf4bc4c",
"_type": "request",
"name": "Creates a batch number for a given plant and material.",
"description": "There are synchronous and asynchronous types of batch creation. The type of batch creation used is determined by the numbering configuration (in the Manage Next Numbers app) for batch number. If the Source is \"ERP\", batch number is created in ERP system and synchronously transferred to SAP Digital Manufacturing. If the Source is \"Local\", batch number is firstly created in SAP Digital Manufacturing and then synchronized to ERP system.",
"method": "POST",
"url": "{{ _.base_url }}/batch",
"parentId": "req_fde53a4a59e2495fb773bb87",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"material\": \"string\",\n \"plant\": \"string\"\n}"
}
},
{
"_id": "req_10cc887115fb4918ba26d525",
"_type": "request",
"name": "Gets batch characteristics.",
"description": "Gets batch characteristics for a given batch number and material from integrated ERP. If the batch number is created in SAP Digital Manufacturing, it must be validated in ERP first, otherwise 404 response will be returned. To use this API, make sure the collaboration link 'COLLABORATION_BATCH_CHARACTERISTICS' is mapped to the directive 'BATCH_CHARACTERISTICS' in the Manage Collaboration Links app.",
"method": "GET",
"url": "{{ _.base_url }}/batchCharacteristics",
"parentId": "req_fde53a4a59e2495fb773bb87",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "batchNumber",
"value": "",
"description": "The batch number",
"disabled": false
},
{
"name": "material",
"value": "",
"description": "The material name which the batch number is assigned to",
"disabled": false
},
{
"name": "plant",
"value": "",
"description": "The plant name",
"disabled": false
}
],
"authentication": {}
},
{
"_id": "req_7b0c613f49034b92a8873180",
"_type": "request",
"name": "Create or update batch characteristics.",
"description": "Create or update batch characteristics for a given batch number, material and plant. If the batch number is created in SAP Digital Manufacturing, it must be validated in ERP first, otherwise 404 response will be returned.",
"method": "POST",
"url": "{{ _.base_url }}/batchCharacteristics",
"parentId": "req_fde53a4a59e2495fb773bb87",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"batchNumber\": \"string\",\n \"material\": \"string\",\n \"plant\": \"string\"\n}"
}
},
{
"_id": "req_eea944d022a14c7aa60794ad",
"_type": "request",
"name": "Retrieves batches and batch characteristics for a given plant and material.",
"description": "Use this API service to get batches and batch characteristic values for a specific material of a given plant from the local batch information downloaded from ERP. You can use the following fields to sort the retrieved batch numbers: 'batchNumber', 'manufacturingDateTime' and 'shelfLifeExpirationDate'. ",
"method": "GET",
"url": "{{ _.base_url }}/batches",
"parentId": "req_fde53a4a59e2495fb773bb87",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "batchNumber",
"value": "",
"description": "The batch number you want to retrieve",
"disabled": true
},
{
"name": "includeCharacteristics",
"value": "",
"description": "Indicates whether the result should include the batch characteristics or not.",
"disabled": true
},
{
"name": "material",
"value": "",
"description": "The material that the batch is associated with",
"disabled": false
},
{
"name": "page",
"value": "",
"description": "The page number you want to query. Number 0 is the first page. Example: https://xxx/v1/batches?plant=SHA4&material=BIKE_B&page=0&size=1",
"disabled": true
},
{
"name": "plant",
"value": "",
"description": "The plant that the material resides in",
"disabled": false
},
{
"name": "size",
"value": "",
"description": "The page size determines how many batches are displayed in one page. Default page size is 20.",
"disabled": true
},
{
"name": "sort",
"value": "",
"description": "The retrieved batch numbers can be sorted using one or more of the following fields: 'batchNumber', 'manufacturingDateTime', and 'shelfLifeExpirationDate'. Example: 'https://xxx/v1/batches?xxxx&sort=batchNumber,asc&sort=manufacturingDateTime,desc'",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_16f43b6f30024cb59b372389",
"_type": "request",
"name": "Synchronizes batch information from the integrated ERP system to SAP Digital Manufacturing (DMC) for a given plant, material, and batch number.",
"description": "Retrieves batch basic data and characteristics from the integrated ERP system, and synchronizes the information to SAP DMC for a given batch number, material and plant.
There are 4 possible use cases:
1) If the specified batch exists in both DMC and ERP, the batch information is retrieved and synchronized, and the batch status is set to 'VALIDATED' in DMC;
2) If the specified batch exists in DMC but not in ERP, the batch status is updated to 'INVALIDATED' in DMC;
3) If the specified batch exists in ERP but not in DMC, a batch is created in DMC in correspondence to the batch that exists in ERP, and its status is set to 'VALIDATED' directly;
4) If the specified batch doesn't exist in either DMC or ERP, this API returns an error with HTTP status code '404'.",
"method": "POST",
"url": "{{ _.base_url }}/batches/{batchNumber}/synchronization",
"parentId": "req_fde53a4a59e2495fb773bb87",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "material",
"value": "",
"description": "The material that the batch is associated with",
"disabled": false
},
{
"name": "plant",
"value": "",
"description": "The plant that the material resides in",
"disabled": false
}
],
"authentication": {}
},
{
"_id": "req_ab83390eb9dd477b82ed6e78",
"_type": "request",
"name": "Updates batch information for a given plant, material and batch number.",
"description": "Updates batch basic data for a given plant, material and batch number, and synchronizes the updated information to the integrated ERP system.",
"method": "PATCH",
"url": "{{ _.base_url }}/batches/{batchNumber}",
"parentId": "req_fde53a4a59e2495fb773bb87",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "The plant that the material resides in",
"disabled": false
},
{
"name": "material",
"value": "",
"description": "The material that the batch is associated with",
"disabled": false
}
],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"lastModifiedDateTime\": \"2024-01-01T00:00:00Z\"\n}"
}
},
{
"_id": "req_b5d32b16c54f42858e705f03",
"_type": "request_group",
"name": "Batch",
"description": "Create batches and retrieve batch characteristics, update or sync batch information.",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_4108848862ad43829db7451a",
"_type": "request",
"name": "Retrieves batches and batch characteristics for a given plant and material.",
"description": "Use this API service to get batches and batch characteristic values for a specific material of a given plant from the local batch information downloaded from ERP. You can use the following fields to sort the retrieved batch numbers: 'batchNumber', 'productionDate' and 'shelfLifeExpirationDate'. ",
"method": "GET",
"url": "{{ _.base_url }}/batches",
"parentId": "req_b5d32b16c54f42858e705f03",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "batchNumber",
"value": "",
"description": "The batch number.",
"disabled": true
},
{
"name": "includeCharacteristics",
"value": "",
"description": "Indicates whether the result should include the batch characteristics or not.",
"disabled": true
},
{
"name": "material",
"value": "",
"description": "The material associated with the batch.",
"disabled": false
},
{
"name": "page",
"value": "",
"description": "The page number you want to query. Number 0 is the first page. Example: https://xxx/v1/batches?plant=SHA4&material=BIKE_B&page=0&size=1",
"disabled": true
},
{
"name": "plant",
"value": "",
"description": "The plant name.",
"disabled": false
},
{
"name": "size",
"value": "",
"description": "The page size determines how many batches are displayed in one page. Default page size is 20.",
"disabled": true
},
{
"name": "sort",
"value": "",
"description": "The retrieved batch numbers can be sorted using one or more of the following fields: 'batchNumber', 'productionDate', and 'shelfLifeExpirationDate'. Example: 'https://xxx/v2/batches?xxxx&sort=batchNumber,asc&sort=productionDate,desc'",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_2257fee6d22b4f6482afded4",
"_type": "request",
"name": "Creates a batch number for a given plant and material.",
"description": "There are synchronous and asynchronous types of batch creation. The type of batch creation used is determined by the numbering configuration (in the Manage Next Numbers app) for batch number. If the Source is \"ERP\", batch number is created in ERP system and synchronously transferred to SAP Digital Manufacturing. If the Source is \"Local\", batch number is firstly created in SAP Digital Manufacturing and then synchronized to ERP system.",
"method": "POST",
"url": "{{ _.base_url }}/batches",
"parentId": "req_b5d32b16c54f42858e705f03",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"material\": \"string\",\n \"plant\": \"string\"\n}"
}
},
{
"_id": "req_069f4a82570248569adddb38",
"_type": "request",
"name": "Gets batch characteristics.",
"description": "Gets batch characteristics for a given batch number and material from integrated ERP. If the batch number is created in SAP Digital Manufacturing, it must be validated in ERP first, otherwise 400 response will be returned. To use this API, make sure the collaboration link 'COLLABORATION_BATCH_CHARACTERISTICS' is mapped to the directive 'BATCH_CHARACTERISTICS' or 'BATCH_CHARACTERISTICS_V2' in the Manage Collaboration Links app.",
"method": "GET",
"url": "{{ _.base_url }}/batchCharacteristics",
"parentId": "req_b5d32b16c54f42858e705f03",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "batchNumber",
"value": "",
"description": "The batch number.",
"disabled": false
},
{
"name": "material",
"value": "",
"description": "The material associated with the batch.",
"disabled": false
},
{
"name": "plant",
"value": "",
"description": "The plant name.",
"disabled": false
}
],
"authentication": {}
},
{
"_id": "req_b17e6f3eda72456a9e479153",
"_type": "request",
"name": "Create or update batch characteristics.",
"description": "Create or update batch characteristics for a given batch number, material and plant. If the batch number is created in SAP Digital Manufacturing, it must be validated in ERP first, otherwise 400 response will be returned.",
"method": "POST",
"url": "{{ _.base_url }}/batchCharacteristics",
"parentId": "req_b5d32b16c54f42858e705f03",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"batchNumber\": \"string\",\n \"material\": \"string\",\n \"plant\": \"string\"\n}"
}
},
{
"_id": "req_6d82b5a99e9d452faca7b6a6",
"_type": "request_group",
"name": "Bill of Material",
"description": "Manage bill of materials",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_5ea5fc39eafc40fcb8df2986",
"_type": "request",
"name": "Find BOM.",
"description": "Finds a BOM by plant, name and type.",
"method": "GET",
"url": "{{ _.base_url }}/boms",
"parentId": "req_6d82b5a99e9d452faca7b6a6",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "bom",
"value": "",
"description": "BOM name",
"disabled": false
},
{
"name": "plant",
"value": "",
"description": "Plant for which request is executed",
"disabled": false
},
{
"name": "type",
"value": "",
"description": "BOM type \nPossible values: \nMASTER - Master BOM; \nSHOP_ORDER - Shop Order Specific BOM; \nSFC - SFC Specific BOM.",
"disabled": false
},
{
"name": "version",
"value": "",
"description": "BOM version. If not specified, current version will be returned.",
"disabled": true
},
{
"name": "readReservationsAndBatch",
"value": "",
"description": "If true, then the system reads the data related to the following fields: the reservation order and item, batch number, and warehouse number. If this data is not needed to execute custom business logic, then this option can be set to false to improve BOM retrieval.",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_70efeddc86564a6f94026d25",
"_type": "request",
"name": "Create BOM.",
"description": "Creates a list of BOMs.",
"method": "POST",
"url": "{{ _.base_url }}/boms",
"parentId": "req_6d82b5a99e9d452faca7b6a6",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "[\n {\n \"assemblyDataType\": {\n \"category\": \"string\",\n \"dataFieldList\": [\n {}\n ],\n \"dataType\": \"string\",\n \"description\": \"string\"\n },\n \"baseQuantity\": 0.0,\n \"baseUnitOfMeasure\": \"string\",\n \"bom\": \"string\",\n \"bomType\": \"string\",\n \"components\": [\n {\n \"alternates\": {},\n \"alternatesEnabled\": {},\n \"alternativeItemGroup\": {},\n \"assemblyDataType\": {},\n \"assemblyOperationActivity\": {},\n \"assemblyQuantityAsRequired\": {},\n \"backflushEnabled\": {},\n \"batchNumber\": {},\n \"componentScrap\": {},\n \"componentType\": {},\n \"customValues\": {},\n \"erpSequence\": {},\n \"material\": {},\n \"orderItemNumber\": {},\n \"quantity\": {},\n \"refDes\": {},\n \"reservationItemNumber\": {},\n \"reservationOrderNumber\": {},\n \"sequence\": {},\n \"storageLocation\": {},\n \"toleranceOver\": {},\n \"toleranceUnder\": {},\n \"totalQuantity\": {},\n \"unitOfMeasure\": {},\n \"warehouseNumber\": {}\n }\n ],\n \"currentVersion\": true,\n \"customValues\": [\n {\n \"attribute\": {},\n \"value\": {}\n }\n ],\n \"description\": \"string\",\n \"plant\": \"string\",\n \"status\": \"string\",\n \"version\": \"string\"\n }\n]"
}
},
{
"_id": "req_c26c9bf5768c45c088a6a813",
"_type": "request",
"name": "Update BOM.",
"description": "Updates a list of objects. Every material to update must have bom, plant, version, type fields specified. Only fields to update can be specified. Every unspecified field will remain unchanged.",
"method": "PATCH",
"url": "{{ _.base_url }}/boms",
"parentId": "req_6d82b5a99e9d452faca7b6a6",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "[\n {\n \"assemblyDataType\": {\n \"category\": \"string\",\n \"dataFieldList\": [\n {}\n ],\n \"dataType\": \"string\",\n \"description\": \"string\"\n },\n \"baseQuantity\": 0.0,\n \"baseUnitOfMeasure\": \"string\",\n \"bom\": \"string\",\n \"bomType\": \"string\",\n \"components\": [\n {\n \"alternates\": {},\n \"alternatesEnabled\": {},\n \"alternativeItemGroup\": {},\n \"assemblyDataType\": {},\n \"assemblyOperationActivity\": {},\n \"assemblyQuantityAsRequired\": {},\n \"backflushEnabled\": {},\n \"batchNumber\": {},\n \"componentScrap\": {},\n \"componentType\": {},\n \"customValues\": {},\n \"erpSequence\": {},\n \"material\": {},\n \"orderItemNumber\": {},\n \"quantity\": {},\n \"refDes\": {},\n \"reservationItemNumber\": {},\n \"reservationOrderNumber\": {},\n \"sequence\": {},\n \"storageLocation\": {},\n \"toleranceOver\": {},\n \"toleranceUnder\": {},\n \"totalQuantity\": {},\n \"unitOfMeasure\": {},\n \"warehouseNumber\": {}\n }\n ],\n \"currentVersion\": true,\n \"customValues\": [\n {\n \"attribute\": {},\n \"value\": {}\n }\n ],\n \"description\": \"string\",\n \"plant\": \"string\",\n \"status\": \"string\",\n \"version\": \"string\"\n }\n]"
}
},
{
"_id": "req_93643ea63f3149adb7235a2e",
"_type": "request",
"name": "Delete BOM.",
"description": "Deletes a BOM by plant, name, version, and type.",
"method": "DELETE",
"url": "{{ _.base_url }}/boms",
"parentId": "req_6d82b5a99e9d452faca7b6a6",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "bom",
"value": "",
"description": "bom",
"disabled": false
},
{
"name": "bomType",
"value": "",
"description": "BOM type",
"disabled": false
},
{
"name": "plant",
"value": "",
"description": "Plant for which request is executed",
"disabled": false
},
{
"name": "version",
"value": "",
"description": "version",
"disabled": false
}
],
"authentication": {}
},
{
"_id": "req_db0c2089af5b47a393885fed",
"_type": "request",
"name": "Create BOM components.",
"description": "Creates a list of components for a paeticular BOM and BOM version.",
"method": "POST",
"url": "{{ _.base_url }}/boms/{bom}/{version}/components",
"parentId": "req_6d82b5a99e9d452faca7b6a6",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "bomType",
"value": "",
"description": "BOM Type",
"disabled": false
},
{
"name": "plant",
"value": "",
"description": "Plant for which request is executed",
"disabled": false
}
],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "[\n {\n \"alternates\": [\n {\n \"enabled\": {},\n \"material\": {},\n \"priority\": {},\n \"required\": {}\n }\n ],\n \"alternatesEnabled\": true,\n \"alternativeItemGroup\": \"string\",\n \"assemblyDataType\": {\n \"category\": \"string\",\n \"dataFieldList\": [\n {}\n ],\n \"dataType\": \"string\",\n \"description\": \"string\"\n },\n \"assemblyOperationActivity\": {\n \"operationActivity\": \"string\",\n \"version\": \"string\"\n },\n \"assemblyQuantityAsRequired\": true,\n \"backflushEnabled\": true,\n \"batchNumber\": \"string\",\n \"componentScrap\": 0.0,\n \"componentType\": \"string\",\n \"customValues\": [\n {\n \"attribute\": {},\n \"value\": {}\n }\n ],\n \"erpSequence\": 0,\n \"material\": {\n \"material\": \"string\",\n \"plant\": \"string\",\n \"version\": \"string\"\n },\n \"orderItemNumber\": \"string\",\n \"quantity\": 0.0,\n \"refDes\": {\n \"description\": \"string\",\n \"erpRefDesSequence\": 0,\n \"quantity\": 0.0,\n \"refDes\": \"string\",\n \"sequence\": 0\n },\n \"reservationItemNumber\": \"string\",\n \"reservationOrderNumber\": \"string\",\n \"sequence\": 0,\n \"storageLocation\": \"string\",\n \"toleranceOver\": 0.0,\n \"toleranceUnder\": 0.0,\n \"totalQuantity\": 0.0,\n \"unitOfMeasure\": \"string\",\n \"warehouseNumber\": \"string\"\n }\n]"
}
},
{
"_id": "req_3d29653e08b240a38a830add",
"_type": "request",
"name": "Update BOM component.",
"description": "Updates a list of objects. Every component to update must have sequence field specified. Only fields to update can be specified. Every unspecified field will remain unchanged.",
"method": "PATCH",
"url": "{{ _.base_url }}/boms/{bom}/{version}/components/{sequence}",
"parentId": "req_6d82b5a99e9d452faca7b6a6",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "bomType",
"value": "",
"description": "BOM type",
"disabled": false
},
{
"name": "plant",
"value": "",
"description": "Plant for which request is executed",
"disabled": false
}
],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"alternates\": [\n {\n \"enabled\": true,\n \"material\": {\n \"material\": {},\n \"plant\": {},\n \"version\": {}\n },\n \"priority\": 0,\n \"required\": true\n }\n ],\n \"alternatesEnabled\": true,\n \"alternativeItemGroup\": \"string\",\n \"assemblyDataType\": {\n \"category\": \"string\",\n \"dataFieldList\": [\n {\n \"dataField\": {},\n \"required\": {},\n \"sequence\": {}\n }\n ],\n \"dataType\": \"string\",\n \"description\": \"string\"\n },\n \"assemblyOperationActivity\": {\n \"operationActivity\": \"string\",\n \"version\": \"string\"\n },\n \"assemblyQuantityAsRequired\": true,\n \"backflushEnabled\": true,\n \"batchNumber\": \"string\",\n \"componentScrap\": 0.0,\n \"componentType\": \"string\",\n \"customValues\": [\n {\n \"attribute\": \"string\",\n \"value\": \"string\"\n }\n ],\n \"erpSequence\": 0,\n \"material\": {\n \"material\": \"string\",\n \"plant\": \"string\",\n \"version\": \"string\"\n },\n \"orderItemNumber\": \"string\",\n \"quantity\": 0.0,\n \"refDes\": {\n \"description\": \"string\",\n \"erpRefDesSequence\": 0,\n \"quantity\": 0.0,\n \"refDes\": \"string\",\n \"sequence\": 0\n },\n \"reservationItemNumber\": \"string\",\n \"reservationOrderNumber\": \"string\",\n \"sequence\": 0,\n \"storageLocation\": \"string\",\n \"toleranceOver\": 0.0,\n \"toleranceUnder\": 0.0,\n \"totalQuantity\": 0.0,\n \"unitOfMeasure\": \"string\",\n \"warehouseNumber\": \"string\"\n}"
}
},
{
"_id": "req_5af08e6fe6d740758928e3bb",
"_type": "request",
"name": "Delete BOM component.",
"description": "Deletes a component by sequence.",
"method": "DELETE",
"url": "{{ _.base_url }}/boms/{bom}/{version}/components/{sequence}",
"parentId": "req_6d82b5a99e9d452faca7b6a6",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "bomType",
"value": "",
"description": "BOM type",
"disabled": false
},
{
"name": "plant",
"value": "",
"description": "Plant for which request is executed",
"disabled": false
}
],
"authentication": {}
},
{
"_id": "req_162b2329c8244c3797474af9",
"_type": "request",
"name": "Finds BOM header details.",
"description": "This endpoint can be called to find a BOM's header details by using search parameters. The required parameters are plant, BOM name, and type. The version is optional. If a version is not present, the current BOM version will be used.",
"method": "GET",
"url": "{{ _.base_url }}/boms/headerDetails",
"parentId": "req_6d82b5a99e9d452faca7b6a6",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "bom",
"value": "",
"description": "BOM name",
"disabled": false
},
{
"name": "plant",
"value": "",
"description": "The plant for which the request is executed",
"disabled": false
},
{
"name": "type",
"value": "",
"description": "BOM type \nPossible values: \nMASTER - Master BOM; \nSHOP_ORDER - Shop Order Specific BOM; \nSFC - SFC Specific BOM.",
"disabled": false
},
{
"name": "version",
"value": "",
"description": "BOM version. If not specified, the current version \u0456s returned.",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_98b73764a0c6422c84c88572",
"_type": "request_group",
"name": "Certification",
"description": "Checks certifications for the user.",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_8afc1410e9674e04a65a188c",
"_type": "request",
"name": "Checks certifications for a user",
"description": "Checks certifications for a user based on the input provided in the request.",
"method": "POST",
"url": "{{ _.base_url }}/certifications/check",
"parentId": "req_98b73764a0c6422c84c88572",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"checkCertifications\": [\n {\n \"material\": \"string\",\n \"materialVersion\": \"string\",\n \"operation\": \"string\",\n \"resource\": \"string\",\n \"userId\": \"string\"\n }\n ],\n \"plant\": \"string\"\n}"
}
},
{
"_id": "req_fe67a83f607a4aff88b0fb39",
"_type": "request",
"name": "Retrieves a list of certifications.",
"description": "Retrieves a list of certifications by plant or by certification name and plant.",
"method": "GET",
"url": "{{ _.base_url }}/certifications",
"parentId": "req_98b73764a0c6422c84c88572",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "The plant containing a certification.",
"disabled": false
},
{
"name": "certification",
"value": "",
"description": "The certification name to retrieve a certification.",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_f4bd6e4e5c3e462694e057b1",
"_type": "request",
"name": "Creates a certification.",
"description": "Creates a certification by the given request.",
"method": "POST",
"url": "{{ _.base_url }}/certifications",
"parentId": "req_98b73764a0c6422c84c88572",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"certification\": \"string\",\n \"certificationDurationType\": \"string\",\n \"certificationDurationUnit\": \"string\",\n \"certificationExtensionUnit\": \"string\",\n \"certificationRequirements\": [\n {\n \"material\": {\n \"material\": {},\n \"plant\": {},\n \"version\": {}\n },\n \"operation\": {\n \"operationActivity\": {},\n \"plant\": {},\n \"version\": {}\n },\n \"resource\": {\n \"plant\": {},\n \"resource\": {}\n }\n }\n ],\n \"createdDateTime\": \"2024-01-01T00:00:00Z\",\n \"customValues\": [\n {\n \"attribute\": \"string\",\n \"value\": \"string\"\n }\n ],\n \"description\": \"string\",\n \"duration\": 0.0,\n \"maxExtensionDuration\": 0.0,\n \"modifiedDateTime\": \"2024-01-01T00:00:00Z\",\n \"noOfExtensions\": 0.0,\n \"plant\": \"string\",\n \"status\": \"string\"\n}"
}
},
{
"_id": "req_3cab61ae6a13446fab68d561",
"_type": "request",
"name": "Updates the certification.",
"description": "Updates the existing certification by the given request.",
"method": "PATCH",
"url": "{{ _.base_url }}/certifications",
"parentId": "req_98b73764a0c6422c84c88572",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"certification\": \"string\",\n \"certificationDurationType\": \"string\",\n \"certificationDurationUnit\": \"string\",\n \"certificationExtensionUnit\": \"string\",\n \"certificationRequirements\": [\n {\n \"material\": {\n \"material\": {},\n \"plant\": {},\n \"version\": {}\n },\n \"operation\": {\n \"operationActivity\": {},\n \"plant\": {},\n \"version\": {}\n },\n \"resource\": {\n \"plant\": {},\n \"resource\": {}\n }\n }\n ],\n \"createdDateTime\": \"2024-01-01T00:00:00Z\",\n \"customValues\": [\n {\n \"attribute\": \"string\",\n \"value\": \"string\"\n }\n ],\n \"description\": \"string\",\n \"duration\": 0.0,\n \"maxExtensionDuration\": 0.0,\n \"modifiedDateTime\": \"2024-01-01T00:00:00Z\",\n \"noOfExtensions\": 0.0,\n \"plant\": \"string\",\n \"status\": \"string\"\n}"
}
},
{
"_id": "req_c195af9f3f6145749e53d4d3",
"_type": "request",
"name": "Deletes the certification.",
"description": "Deletes a certification for a given plant",
"method": "DELETE",
"url": "{{ _.base_url }}/certifications",
"parentId": "req_98b73764a0c6422c84c88572",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {}
},
{
"_id": "req_17d62f58e95644558e158a3f",
"_type": "request",
"name": "Retrieves a list of custom field definitions for the certification.",
"description": "Returns all maintained custom field definitions, for a given plant.",
"method": "GET",
"url": "{{ _.base_url }}/customFieldDefinitions",
"parentId": "req_98b73764a0c6422c84c88572",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "The plant where a custom field definitions are defined.",
"disabled": false
}
],
"authentication": {}
},
{
"_id": "req_2007389936ac4f6587d11971",
"_type": "request",
"name": "Creates a custom field definition for the certification.",
"description": "Creates a custom field definition for the certification.",
"method": "POST",
"url": "{{ _.base_url }}/customFieldDefinitions",
"parentId": "req_98b73764a0c6422c84c88572",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"fieldName\": \"string\",\n \"plant\": \"string\"\n}"
}
},
{
"_id": "req_75ff881c2052445995bf7193",
"_type": "request",
"name": "Updates a custom field definition for the certification.",
"description": "Updates field label or sequence in the custom field definition for the certification.",
"method": "PATCH",
"url": "{{ _.base_url }}/customFieldDefinitions",
"parentId": "req_98b73764a0c6422c84c88572",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"fieldName\": \"string\",\n \"modifiedDateTime\": \"2024-01-01T00:00:00Z\",\n \"plant\": \"string\"\n}"
}
},
{
"_id": "req_f19e3666a05e4f7f903a0485",
"_type": "request",
"name": "Deletes a custom field definition for the certification.",
"description": "Deletes a custom field definition for the certification.",
"method": "DELETE",
"url": "{{ _.base_url }}/customFieldDefinitions",
"parentId": "req_98b73764a0c6422c84c88572",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {}
},
{
"_id": "req_c8f215805aff48ca950d75fc",
"_type": "request_group",
"name": "Classification",
"description": "Obtain details on the classes and characteristics of the materials",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_b311fa132c11480298a222f0",
"_type": "request",
"name": "Retrieves classes and characteristics by materials, class type and classes.",
"description": "Retrieve a list of classes and characteristics by multiple material, class type and classes.",
"method": "POST",
"url": "{{ _.base_url }}/read",
"parentId": "req_c8f215805aff48ca950d75fc",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"classType\": \"string\",\n \"objectKeys\": [\n \"string\"\n ],\n \"objectType\": \"string\",\n \"plant\": \"string\"\n}"
}
},
{
"_id": "req_623e2d43b34c4c2d8b97575e",
"_type": "request_group",
"name": "Data Collection",
"description": "Manage data collections",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_3fabce91578a421485aabdc1",
"_type": "request",
"name": "Logs values for data collection parameters.",
"description": "This endpoint can be called to log values for data collection parameters against an SFC at a given operation, resource and location.",
"method": "POST",
"url": "{{ _.base_url }}/log",
"parentId": "req_623e2d43b34c4c2d8b97575e",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"group\": {\n \"dcGroup\": \"string\",\n \"version\": \"string\"\n },\n \"operation\": {\n \"operation\": \"string\",\n \"version\": \"string\"\n },\n \"parameterValues\": [\n {\n \"name\": \"string\"\n }\n ],\n \"plant\": \"string\",\n \"resource\": \"string\",\n \"sfcs\": [\n \"string\"\n ]\n}"
}
},
{
"_id": "req_f8584ac8e6be42a18108f64e",
"_type": "request",
"name": "Standalone / Non-WIP logs values for data collection parameters.",
"description": "This endpoint allows logging standalone / non-WIP values for data collection parameters at the SFC level, bypassing the need for operation, resource, and location details.",
"method": "POST",
"url": "{{ _.base_url }}/standalone/log",
"parentId": "req_623e2d43b34c4c2d8b97575e",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"group\": {\n \"dcGroup\": \"string\",\n \"version\": \"string\"\n },\n \"parameterValues\": [\n {\n \"name\": \"string\"\n }\n ],\n \"plant\": \"string\",\n \"sfc\": \"string\"\n}"
}
},
{
"_id": "req_cf1e550eb10f44b5a02aaf60",
"_type": "request",
"name": "Upload a file with metadata for non-WIP data collection.",
"description": "Uploads a file along with metadata for non-WIP data collection parameters. Only one file is allowed per request.",
"method": "POST",
"url": "{{ _.base_url }}/nonwip/uploadFile",
"parentId": "req_623e2d43b34c4c2d8b97575e",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {}
},
{
"_id": "req_e1b9b43b5af74160b18dc65b",
"_type": "request",
"name": "Endpoint returning collected data for SFCs.",
"description": "Returns all the previously collected parameter data for given SFC(s) at the given operation and resource.",
"method": "GET",
"url": "{{ _.base_url }}/parameters",
"parentId": "req_623e2d43b34c4c2d8b97575e",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "dcGroup.name",
"value": "",
"description": "Data Collection Group where data has been collected. ",
"disabled": true
},
{
"name": "dcGroup.version",
"value": "",
"description": "Data Collection Group version where data has been collected. ",
"disabled": true
},
{
"name": "operation.name",
"value": "",
"description": "Operation where data has been collected. ",
"disabled": false
},
{
"name": "operation.version",
"value": "",
"description": "Operation version data has been collected. ",
"disabled": false
},
{
"name": "parameterName",
"value": "",
"description": "Filter results by a Data Collection Parameter name. ",
"disabled": true
},
{
"name": "plant",
"value": "",
"description": "Plant where data has been collected.",
"disabled": false
},
{
"name": "resource",
"value": "",
"description": "The resource where data has been collected.",
"disabled": false
},
{
"name": "sfcs",
"value": "",
"description": "One or more of SFC(s) the data has been collected for.",
"disabled": false
}
],
"authentication": {}
},
{
"_id": "req_937a65c05f8b46a5b7eb66e6",
"_type": "request",
"name": "Returns a data collection group.",
"description": "Returns a data collection group for a given plant, and optionally for a given version. If no version is specified, then the endpoint returns the latest version of the data collection group.",
"method": "GET",
"url": "{{ _.base_url }}/groups",
"parentId": "req_623e2d43b34c4c2d8b97575e",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "group",
"value": "",
"description": "Data Collection Group",
"disabled": false
},
{
"name": "plant",
"value": "",
"description": "Plant",
"disabled": false
},
{
"name": "version",
"value": "",
"description": "Data Collection Version",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_133ab01708244cf8a86114d9",
"_type": "request",
"name": "Create a new data collection group.",
"description": "Creates a new data collection group for processing product related data.",
"method": "POST",
"url": "{{ _.base_url }}/groups",
"parentId": "req_623e2d43b34c4c2d8b97575e",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"group\": \"string\",\n \"plant\": \"string\",\n \"version\": \"string\"\n}"
}
},
{
"_id": "req_69998b1dc194446aa698c2cf",
"_type": "request",
"name": "Update a data collection group.",
"description": "Updates the data collection group. Before you call this endpoint, provide the value for \u201cmodifiedDataTime\u201d parameter. The value is obtained from the get response.",
"method": "PUT",
"url": "{{ _.base_url }}/groups",
"parentId": "req_623e2d43b34c4c2d8b97575e",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"group\": \"string\",\n \"modifiedDateTime\": \"string\",\n \"plant\": \"string\",\n \"version\": \"string\"\n}"
}
},
{
"_id": "req_ad60df967e334c4dbc672851",
"_type": "request",
"name": "Delete a data collection group.",
"description": "Deletes a given data collection group for a given plant and version.",
"method": "DELETE",
"url": "{{ _.base_url }}/groups",
"parentId": "req_623e2d43b34c4c2d8b97575e",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "group",
"value": "",
"description": "Data Collection Group",
"disabled": false
},
{
"name": "plant",
"value": "",
"description": "Plant",
"disabled": false
},
{
"name": "version",
"value": "",
"description": "Data Collection Version",
"disabled": false
}
],
"authentication": {}
},
{
"_id": "req_e61288f7b9f649948cd8ec9e",
"_type": "request",
"name": "Obtains a list of data collection groups.",
"description": "This endpoint can be called to obtain a list of data collection groups in effect for an SFC in order to collect data against.",
"method": "GET",
"url": "{{ _.base_url }}/sfc/groups",
"parentId": "req_623e2d43b34c4c2d8b97575e",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "operation",
"value": "",
"description": "The Operation on the given SFC data collect against. Either this entry or stepId is required.",
"disabled": true
},
{
"name": "plant",
"value": "",
"description": "Plant",
"disabled": false
},
{
"name": "resource",
"value": "",
"description": "Resource at which data collection is performed.",
"disabled": false
},
{
"name": "sfc",
"value": "",
"description": "The SFC to data collect against.",
"disabled": false
},
{
"name": "stepId",
"value": "",
"description": "The Step Id on the given SFC to data collect against. Either this entry or operation is required",
"disabled": true
},
{
"name": "workCenter",
"value": "",
"description": "Work center where data collection is performed.",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_cd1a0c3fcdec40e789e5fffd",
"_type": "request",
"name": "Retrieves records of SFCs.",
"description": " Retrieves parameters of SFCs based on the input filters. You can provide either SFCs or startDateTime and endDateTime. StartDateTime and EndDateTime difference should not be more than 30 days.",
"method": "GET",
"url": "{{ _.base_url }}/measurements",
"parentId": "req_623e2d43b34c4c2d8b97575e",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "dcGroup.name",
"value": "",
"description": "The name of the data collection group for which the data has been collected. ",
"disabled": true
},
{
"name": "dcGroup.version",
"value": "",
"description": "The version of the data collection group for which the data has been collected. ",
"disabled": true
},
{
"name": "operation.name",
"value": "",
"description": "The name of the operation for which the data has been collected. ",
"disabled": true
},
{
"name": "operation.version",
"value": "",
"description": "The version of the operation for which the data has been collected. ",
"disabled": true
},
{
"name": "parameterName",
"value": "",
"description": "Filter results by name of the data collection parameter. ",
"disabled": true
},
{
"name": "plant",
"value": "",
"description": "The plant for which the data has been collected.",
"disabled": false
},
{
"name": "resource",
"value": "",
"description": " The resource for which the data has been collected.",
"disabled": true
},
{
"name": "sfcs",
"value": "",
"description": "The SFCs for which the data has been collected.",
"disabled": true
},
{
"name": "pageNumber",
"value": "",
"description": "The current page of the record. Page number starts from 0.",
"disabled": true
},
{
"name": "pageSize",
"value": "",
"description": "The page size determines the number of records to be displayed in a single page. Default size is 20. Threshold is 50.",
"disabled": true
},
{
"name": "startDateTime",
"value": "",
"description": "The start date time for which you need to retrieve the data. Define the value in yyyy-MM-ddTHH:mm:ssZ format.",
"disabled": true
},
{
"name": "endDateTime",
"value": "",
"description": "The end date time for which you need to retrieve the data. Define the value in yyyy-MM-ddTHH:mm:ssZ format.",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_b2a73a3f34dd45cabebee9a0",
"_type": "request",
"name": "Retrieves the measured Non-WIP data collection parameters.",
"description": "Retrieves the measured Non-WIP data collection parameters for the given SFC. You must provide the SFC and plant details. By default, the results are sorted based on the fields: DC Parametric Measure ID, Created At, and SFC",
"method": "GET",
"url": "{{ _.base_url }}/nonwip/measurements",
"parentId": "req_623e2d43b34c4c2d8b97575e",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "The plant for which the data has been collected.",
"disabled": false
},
{
"name": "sfc",
"value": "",
"description": "The Non-WIP SFC for which the data has been collected.",
"disabled": false
},
{
"name": "dcGroup.name",
"value": "",
"description": "The name of the Non-WIP DC group for which the data has been collected.",
"disabled": true
},
{
"name": "dcGroup.version",
"value": "",
"description": "The version of the Non-WIP DC group for which the data has been collected.",
"disabled": true
},
{
"name": "parameterName",
"value": "",
"description": "Filter results by name of the data collection parameter.",
"disabled": true
},
{
"name": "page",
"value": "",
"description": "The current page of the record. Default page number starts from 0.",
"disabled": true
},
{
"name": "size",
"value": "",
"description": "The page size determines the number of records to be displayed in a single page. Default size is 20. Threshold is 50.",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_a8cc4680064e461cb36bf07f",
"_type": "request",
"name": "Fetch the uncollected data collection parameters for the given SFC.",
"description": "Fetch the uncollected data collection parameters for the given SFC for which the data collection groups are in releasable status and parameters in enabled status. The collective missing parameters for the given SFC will be listed.",
"method": "GET",
"url": "{{ _.base_url }}/uncollectedParameters",
"parentId": "req_623e2d43b34c4c2d8b97575e",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "sfc",
"value": "",
"description": "The SFC to get uncollected data collection parameters.",
"disabled": false
},
{
"name": "operation",
"value": "",
"description": "The operation of the SFC being used.",
"disabled": false
},
{
"name": "resource",
"value": "",
"description": "The resource of the SFC being used.",
"disabled": false
},
{
"name": "currentOperationVersionOnly",
"value": "",
"description": "Default true, the uncollected parameters are returned for current operation version. If false, the uncollected parameters are returned for all operation versions.",
"disabled": true
},
{
"name": "plant",
"value": "",
"description": "The plant for which the data collection parameters are fetched.",
"disabled": false
}
],
"authentication": {}
},
{
"_id": "req_7a34db01bf4b448d91ae01d0",
"_type": "request",
"name": "Fetch the uncollected Non-WIP data collection parameters for the given SFC.",
"description": "Fetch the uncollected Non-WIP data collection parameters for the given SFC for which the data collection groups are in releasable status and parameters in enabled status. The collective missing parameters for the given SFC will be listed. By default, the results are sorted based on fields: DC Group Name and Parameter Sequence Order",
"method": "GET",
"url": "{{ _.base_url }}/nonwip/uncollectedParameters",
"parentId": "req_623e2d43b34c4c2d8b97575e",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "sfc",
"value": "",
"description": "The SFC to get uncollected data collection parameters.",
"disabled": false
},
{
"name": "plant",
"value": "",
"description": "The plant for which the data collection parameters are fetched.",
"disabled": false
},
{
"name": "page",
"value": "",
"description": "The current page of the record. Page number starts from 0.",
"disabled": true
},
{
"name": "size",
"value": "",
"description": "The page size determines the number of records to be displayed in a single page. Default size is 20. Threshold is 50.",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_73a2d6ecffce4dad84bfc1fe",
"_type": "request",
"name": "Download the file.",
"description": "Download the data collection file for the given file ID which has been uploaded during data log.",
"method": "GET",
"url": "{{ _.base_url }}/downloadLoggedAttachments",
"parentId": "req_623e2d43b34c4c2d8b97575e",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "fileId",
"value": "",
"description": "The file ID to download the already uploaded file.",
"disabled": false
}
],
"authentication": {}
},
{
"_id": "req_99503cbf58574e929f74759c",
"_type": "request_group",
"name": "Data Fields API",
"description": "Use this API to manage data fields in SAP Digital Manufacturing.",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_4a44cb984a6442f2a4cf95d2",
"_type": "request",
"name": "Gets paginated list of data fields by plant",
"description": "Retrieves a paginated list of data fields for a specific plant",
"method": "GET",
"url": "{{ _.base_url }}/v1/dataFields",
"parentId": "req_99503cbf58574e929f74759c",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "Plant identifier",
"disabled": false
},
{
"name": "fieldName",
"value": "",
"description": "A field name identifier. Use this parameter to retrieve a specific data field. If the parameter is provided, sorting and pagination parameters are ignored.",
"disabled": true
},
{
"name": "page",
"value": "",
"description": "A zero-based page index (0..N)",
"disabled": true
},
{
"name": "size",
"value": "",
"description": "The size of the page to be returned. Maximum size - 50.",
"disabled": true
},
{
"name": "sort",
"value": "",
"description": "Sort criteria according to the format: property,(asc|desc). Multiple sort criteria are supported. Allowed sort fields: fieldName, fieldLabel, description, type, createdDateTime, modifiedDateTime.",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_1fcea030f160416a842a096b",
"_type": "request",
"name": "Creates a list of data fields",
"description": "Creates multiple data field objects",
"method": "POST",
"url": "{{ _.base_url }}/v1/dataFields",
"parentId": "req_99503cbf58574e929f74759c",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "[\n {\n \"fieldName\": \"string\",\n \"plant\": \"string\",\n \"type\": \"string\"\n }\n]"
}
},
{
"_id": "req_79b037bb0c0b41318995b2b2",
"_type": "request",
"name": "Updates a list of data fields",
"description": "Updates multiple data field objects. Only provided fields are updated.",
"method": "PATCH",
"url": "{{ _.base_url }}/v1/dataFields",
"parentId": "req_99503cbf58574e929f74759c",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "[\n {\n \"fieldName\": \"string\",\n \"plant\": \"string\",\n \"type\": \"string\"\n }\n]"
}
},
{
"_id": "req_e716cb5f8d79409b821a635d",
"_type": "request",
"name": "Deletes a data field by plant and field name",
"description": "Removes a data field by its plant and field name",
"method": "DELETE",
"url": "{{ _.base_url }}/v1/dataFields",
"parentId": "req_99503cbf58574e929f74759c",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "fieldName",
"value": "",
"description": "A field name identifier",
"disabled": false
},
{
"name": "plant",
"value": "",
"description": "Plant identifier",
"disabled": false
}
],
"authentication": {}
},
{
"_id": "req_fadb0260e0ae4c9da4553151",
"_type": "request_group",
"name": "Data Type",
"description": "Create, update, retrieve, and delete data types.",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_59219a07fe3a4e2db0c6592f",
"_type": "request",
"name": "Gets paginated list of data types by plant and optional search parameters",
"description": "Retrieves a paginated list of data types for a specific plant with optional filtering by category and data type name",
"method": "GET",
"url": "{{ _.base_url }}/v1/dataTypes",
"parentId": "req_fadb0260e0ae4c9da4553151",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "Plant identifier",
"disabled": false
},
{
"name": "category",
"value": "",
"description": "Data Type category",
"disabled": true
},
{
"name": "dataType",
"value": "",
"description": "Data Type name",
"disabled": true
},
{
"name": "page",
"value": "",
"description": "A zero-based page index (0..N)",
"disabled": true
},
{
"name": "size",
"value": "",
"description": "The size of the page to be returned. Maximum size - 100.",
"disabled": true
},
{
"name": "sort",
"value": "",
"description": "Sort criteria according to the format: property,(asc|desc). Multiple sort criteria are supported. Allowed sort fields: dataType, category.",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_843f4b5685004f91aa04ccf9",
"_type": "request",
"name": "Creates a list of data types",
"description": "Creates multiple data type objects",
"method": "POST",
"url": "{{ _.base_url }}/v1/dataTypes",
"parentId": "req_fadb0260e0ae4c9da4553151",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "[\n {\n \"category\": \"string\",\n \"dataType\": \"string\",\n \"plant\": \"string\"\n }\n]"
}
},
{
"_id": "req_20b25cc7ca7345bead561f8c",
"_type": "request",
"name": "Updates a list of data types",
"description": "Updates one or more data type objects. Only provided fields are updated.",
"method": "PATCH",
"url": "{{ _.base_url }}/v1/dataTypes",
"parentId": "req_fadb0260e0ae4c9da4553151",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "[\n {\n \"category\": \"string\",\n \"dataType\": \"string\",\n \"plant\": \"string\"\n }\n]"
}
},
{
"_id": "req_eae1cac2be7d4c12b4e63875",
"_type": "request",
"name": "Deletes a data type by plant, data type name, and category",
"description": "Deletes a data type by plant, data type name, and category. Only data types with an empty data field list can be deleted.",
"method": "DELETE",
"url": "{{ _.base_url }}/v1/dataTypes",
"parentId": "req_fadb0260e0ae4c9da4553151",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "Plant identifier",
"disabled": false
},
{
"name": "category",
"value": "",
"description": "Data Type category",
"disabled": false
},
{
"name": "dataType",
"value": "",
"description": "Data Type name",
"disabled": false
}
],
"authentication": {}
},
{
"_id": "req_5fe0de021c8c42cbb5def464",
"_type": "request_group",
"name": "Document",
"description": "Manage documents",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_fcdccfb2002f4aaa979ab10c",
"_type": "request",
"name": "Retrieves a page of document print templates.",
"description": "Retrieves a page of document print templates or a specific document print template defined in the request. If the sort parameter is not defined, the results are ordered by the modified date and time in the ascending order. The maximum returned quantity is 100.",
"method": "GET",
"url": "{{ _.base_url }}/documents",
"parentId": "req_5fe0de021c8c42cbb5def464",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "document",
"value": "",
"description": "A document print template name for which a request is executed.",
"disabled": true
},
{
"name": "version",
"value": "",
"description": "A document print template version for which a request is executed.",
"disabled": true
},
{
"name": "size",
"value": "",
"description": "The quantity of document print templates records to be returned. If it is not specified, the default value is 100. The maximum allowed value is 100.",
"disabled": true
},
{
"name": "page",
"value": "",
"description": "The number of a page to be returned. The page number starts from 0. If it is not defined, the first page is returned.",
"disabled": true
},
{
"name": "sort",
"value": "",
"description": "This parameter is used for sorting. To define the sorting order, use comma-separated values, like 'document,desc'. The default sorting order is ascending. The following sorting parameters are supported: modifiedOn, createdOn, document, documentType, description, status, version, currentVersion, dataAcquisitionPlugin, formatterPlugin.",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_06f58adfe7e441ee95cb1620",
"_type": "request",
"name": "Creates a document print template.",
"description": "Creates a document print template by the given request.",
"method": "POST",
"url": "{{ _.base_url }}/documents",
"parentId": "req_5fe0de021c8c42cbb5def464",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"dataAcquisitionPlugin\": {\n \"plugin\": \"string\"\n },\n \"document\": \"string\",\n \"formatterPlugin\": {\n \"plugin\": \"string\"\n },\n \"version\": \"string\"\n}"
}
},
{
"_id": "req_0b69d86742464cea98eb8574",
"_type": "request",
"name": "Updates a document print template.",
"description": "Updates a document print template by the given request.",
"method": "PATCH",
"url": "{{ _.base_url }}/documents",
"parentId": "req_5fe0de021c8c42cbb5def464",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"document\": \"string\",\n \"version\": \"string\"\n}"
}
},
{
"_id": "req_8d496d2f8bb740e6ae60d4c5",
"_type": "request",
"name": "Deletes a document print template",
"description": "Deletes a document print template by the given document name and version.",
"method": "DELETE",
"url": "{{ _.base_url }}/documents",
"parentId": "req_5fe0de021c8c42cbb5def464",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "document",
"value": "",
"description": "A document print template name for which a request is executed.",
"disabled": false
},
{
"name": "version",
"value": "",
"description": "A document print template version for which a request is executed.",
"disabled": false
}
],
"authentication": {}
},
{
"_id": "req_1900d12936594d07bc9ec1a3",
"_type": "request",
"name": "Downloads a document print template file.",
"description": "Downloads the attached template file from the document print template using the document name and version.",
"method": "GET",
"url": "{{ _.base_url }}/download",
"parentId": "req_5fe0de021c8c42cbb5def464",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "document",
"value": "",
"description": "A document print template name for which a request is executed.",
"disabled": false
},
{
"name": "version",
"value": "",
"description": "A document print template version for which a request is executed.",
"disabled": false
}
],
"authentication": {}
},
{
"_id": "req_19cf218334094ef598fe7d2c",
"_type": "request_group",
"name": "Document",
"description": "Retrieve and print documents",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_85ddacb6a83a4a04a40d1a13",
"_type": "request",
"name": "Retrieves document list.",
"description": "Retrieves a list of documents by name.",
"method": "GET",
"url": "{{ _.base_url }}/documents",
"parentId": "req_19cf218334094ef598fe7d2c",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "document",
"value": "",
"description": "The name to retrieve a document.",
"disabled": false
}
],
"authentication": {}
},
{
"_id": "req_53eec8e8690c44e492bcdf1b",
"_type": "request",
"name": "Prints a document. This is now deprecated, please use the endpoint /print of the 'Print Document' API",
"description": "Prints a given document on a given printer. Data for the document is retrieved from an SFC or order provided in parameters.",
"method": "POST",
"url": "{{ _.base_url }}/print",
"parentId": "req_19cf218334094ef598fe7d2c",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"document\": \"string\",\n \"printer\": \"string\"\n}"
}
},
{
"_id": "req_dd2e1f6554e348939fc23f34",
"_type": "request_group",
"name": "Downtime and Speed Loss",
"description": "Report speed loss and downtime",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_dfbb1e4fd45045288599e867",
"_type": "request",
"name": "Creates speed loss",
"description": "Create a new speed loss with Reason Code tagged. You can tag the existing un-tagged speed loss with a reason code for a given duration.",
"method": "POST",
"url": "{{ _.base_url }}/v1/speedLoss",
"parentId": "req_dd2e1f6554e348939fc23f34",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"date\": \"string\",\n \"duration\": 0.0,\n \"operationActivity\": \"string\",\n \"order\": \"string\",\n \"plant\": \"string\",\n \"resource\": \"string\",\n \"resourceReasonCodeId\": \"string\"\n}"
}
},
{
"_id": "req_790c764ddd9948bebcea929b",
"_type": "request",
"name": "Creates downtime",
"description": "Create a downtime for one or more resources of the selected work center. You can create downtime for a specific date or date range and assign a reason code.",
"method": "POST",
"url": "{{ _.base_url }}/v1/downtime",
"parentId": "req_dd2e1f6554e348939fc23f34",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "[\n {\n \"plant\": \"string\",\n \"resource\": \"string\",\n \"status\": \"string\"\n }\n]"
}
},
{
"_id": "req_319f312aa7f7469887280ffb",
"_type": "request_group",
"name": "Electronic Batch Record",
"description": "Creates an electronic batch record",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_45680364b0d84cbaaf32b176",
"_type": "request",
"name": "Create Electronic Batch Record",
"description": "Allows you to create an electronic batch record for a batch and order used for producing a material.",
"method": "POST",
"url": "{{ _.base_url }}/ebrs",
"parentId": "req_319f312aa7f7469887280ffb",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"batch\": \"string\",\n \"material\": \"string\",\n \"materialVersion\": \"string\",\n \"order\": \"string\",\n \"plant\": \"string\"\n}"
}
},
{
"_id": "req_884e0058ffcf495fa31fc880",
"_type": "request_group",
"name": "Electronic Signature",
"description": "Maintain and make available Electronic Signatures in Digital Manufacturing",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_23c597b2052249df9daf4208",
"_type": "request",
"name": "Retrieve a list of electronic signatures.",
"description": "Electronic signatures should be retrievable based on their context, context values, signatory, or any other property of a signature record. See [Samples](https://help.sap.com/docs/sap-digital-manufacturing/apis/electronic-signature-queries)",
"method": "GET",
"url": "{{ _.base_url }}/signatureLogs",
"parentId": "req_884e0058ffcf495fa31fc880",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "$filter",
"value": "",
"description": "Filter items by property values. For more information, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
"disabled": true
},
{
"name": "$orderby",
"value": "",
"description": "Order items by property values. For more information, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
"disabled": true
},
{
"name": "$select",
"value": "",
"description": "Select properties to be returned. For more information, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"disabled": true
},
{
"name": "$expand",
"value": "",
"description": "The value of $expand query option is a comma-separated list of navigation property names, stream property names, or $value indicating the stream content of a media-entity. The corresponding related entities and stream values will be represented inline. For more information, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_90b9bed2945a4a0dbd966503",
"_type": "request_group",
"name": "Extended Warehouse Management Integration",
"description": "Perform logistics related activities in Extended Warehouse Management integration such as material staging and goods receipt",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_e2ec477cdea34fb9a1211415",
"_type": "request",
"name": "Initiates a single-order staging request to Extended Warehouse Management",
"description": "Initiates a material staging request to Extended Warehouse Management for a single order in a given plant. This is now deprecated and will be decommissioned and retired from production in 2411 release, please use the successor API ",
"method": "POST",
"url": "{{ _.base_url }}/ewmSingleOrderStaging",
"parentId": "req_90b9bed2945a4a0dbd966503",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"orderNumber\": \"string\",\n \"plant\": \"string\"\n}"
}
},
{
"_id": "req_b6e0d99661da40399a2a86b8",
"_type": "request_group",
"name": "Extended Warehouse Management Staging",
"description": "Perform material staging related activities in Extended Warehouse Management integration.",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_59bffc91fffe4a72b86974f8",
"_type": "request",
"name": "Retrieves all staging requests for a given plant.",
"description": "Retrieves all staging requests to Extended Warehouse Management for a given plant. You can specify various parameters to refine the results.",
"method": "POST",
"url": "{{ _.base_url }}/staging/stagingRequests/query",
"parentId": "req_b6e0d99661da40399a2a86b8",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "page",
"value": "",
"description": "The page number you want to query. Number 0 is the first page. Example: https://xxx?page=0&size=1.",
"disabled": true
},
{
"name": "size",
"value": "",
"description": "The page size determines how many records are displayed in one page. An internal validation limits the maximum value to 100. If not specified, the default value is 20.",
"disabled": true
},
{
"name": "sort",
"value": "",
"description": "The retrieved records can be sorted using one or more of the following fields: 'createdDateTime', 'stagingRequestNumber', 'stagingRequestItemNumber', 'status', 'material', 'warehouseNumber', 'productionSupplyArea', 'stagingMethod', 'order', 'operation', 'modifiedDateTime' and 'plannedDeliveryDateTime'. By default, the staging requests are sorted by 'modifiedDateTime' in ascending order and 'stagingRequestItemNumber' in ascending order. Example: 'https://xxx?xxxx&sort=modifiedDateTime,desc&sort=operation,desc'.",
"disabled": true
}
],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"plant\": \"string\"\n}"
}
},
{
"_id": "req_83a11a0f753e40be81baf6f7",
"_type": "request",
"name": "Discards multiple staging requests.",
"description": "Discards multiple staging requests for a given plant. You can only discard staging requests that have Delivered status.",
"method": "POST",
"url": "{{ _.base_url }}/staging/stagingRequests/discard",
"parentId": "req_b6e0d99661da40399a2a86b8",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"plant\": \"string\",\n \"stagingRequestNumbers\": [\n \"string\"\n ]\n}"
}
},
{
"_id": "req_4ae5465a92d64e76a8f4306d",
"_type": "request_group",
"name": "Extended Warehouse Management Staging",
"description": "Perform material staging related activities in Extended Warehouse Management integration.",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_c675fa417205482cb9b7f314",
"_type": "request",
"name": "Initiates a staging request to Extended Warehouse Management (EWM)",
"description": "Initiates a staging request to EWM for a given plant. You can post the staging request at order level, or at Shop Floor Control (SFC) level. You can use this API call only if you've enabled MES-driven staging in Extended Warehouse Management integration.",
"method": "POST",
"url": "{{ _.base_url }}/staging/stagingRequest",
"parentId": "req_4ae5465a92d64e76a8f4306d",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"plant\": \"string\",\n \"stagingLevel\": \"string\"\n}"
}
},
{
"_id": "req_e7643b7f11264f71ac25988c",
"_type": "request",
"name": "Retrieves all staging requests for a given plant.",
"description": "Retrieves all staging requests to Extended Warehouse Management for a given plant. You can fill various parameters to narrow down the results.",
"method": "GET",
"url": "{{ _.base_url }}/staging/stagingRequests",
"parentId": "req_4ae5465a92d64e76a8f4306d",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "The plant where the staging requests are performed",
"disabled": false
},
{
"name": "stagingRequestNumber",
"value": "",
"description": "The staging request number which uniquely identifies a staging request. You can check it in the Manage Staging app.",
"disabled": true
},
{
"name": "productionSupplyAreas",
"value": "",
"description": "The list of production supply areas where staged materials are delivered to",
"disabled": true
},
{
"name": "stagingRequestItemStatuses",
"value": "",
"description": "The list of staging request item statuses. You can choose to retrieve staging requests with one of the 9 statuses: 1) 'NEW': Retrieve staging requests that are newly created; 2) 'IN_PROCESS': Retrieve staging requests that are still being processed; 3) 'DELIVERED': Retrieve staging requests that are delivered to Extended Warehouse Management; 4) 'DELIVERY_FAILED': Retrieve staging requests that failed to be delivered to Extended Warehouse Management due to technical reasons; 5) 'INITIALIZED': Retrieve staging requests that are initialized in Extended Warehouse Management; 6) 'NOT_STAGED': Retrieve staging requests where no component is staged; 7) 'PARTIALLY_STAGED': Retrieve staging requests where only part of the requested components are staged to production supply area; 8) 'STAGED': Retrieve staging requests where all requested components are successfully staged to production supply area; 9) 'OVER_STAGED': Retrieve staging requests where components staged exceed the requested quantity; 10) 'DISCARDED': Retrieve staging requests that will not be processed any further.",
"disabled": true
},
{
"name": "orders",
"value": "",
"description": "The list of orders for which the staging requests are performed",
"disabled": true
},
{
"name": "components",
"value": "",
"description": "The list of components that are requested in the staging requests",
"disabled": true
},
{
"name": "operations",
"value": "",
"description": "The list of operations for which the staging requests are performed",
"disabled": true
},
{
"name": "maxCreationTime",
"value": "",
"description": "The upper limit of the creation date time range of the staging requests. Example: 2022-01-01T00:59:59Z",
"disabled": true
},
{
"name": "minCreationTime",
"value": "",
"description": "The lower limit of the creation date time range of the staging requests",
"disabled": true
},
{
"name": "maxPlannedDeliveryTime",
"value": "",
"description": "The upper limit of the planned delivery date time range of the staging requests",
"disabled": true
},
{
"name": "minPlannedDeliveryTime",
"value": "",
"description": "The lower limit of the planned delivery date time range of the staging requests",
"disabled": true
},
{
"name": "page",
"value": "",
"description": "The page number you want to query. Number 0 is the first page. Example: https://xxx?plant=XX&page=0&size=1",
"disabled": true
},
{
"name": "size",
"value": "",
"description": "The page size determines how many records are displayed in one page. Default page size is 20.",
"disabled": true
},
{
"name": "sort",
"value": "",
"description": "The retrieved records can be sorted using one or more of the following fields: 'createdDateTime', 'stagingRequest.id', 'stagingRequestItemNumber', 'status', 'material', 'warehouseNumber', 'productionSupplyArea', 'stagingMethod', 'singleOrderId', 'operation' and 'plannedDeliveryDateTime'. Example: 'https://xxx?xxxx&sort=singleOrderId,desc&sort=operation,desc'",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_87e6d827a5194a39aa4e0345",
"_type": "request",
"name": "Discards multiple staging requests.",
"description": "Discards multiple staging requests for a given plant. You can only discard staging requests that have Delivered status.",
"method": "POST",
"url": "{{ _.base_url }}/staging/stagingRequests/discard",
"parentId": "req_4ae5465a92d64e76a8f4306d",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"plant\": \"string\",\n \"stagingRequestNumbers\": [\n \"string\"\n ]\n}"
}
},
{
"_id": "req_dc9b0a805ed24d428119b017",
"_type": "request",
"name": "Retrieves staging methods of components for a given plant and order.",
"description": "Retrieves the staging methods of components for a specified plant and order. Use the stagingMethod parameter to define the type of staging method to be retrieved.",
"method": "GET",
"url": "{{ _.base_url }}/staging/componentMethods",
"parentId": "req_4ae5465a92d64e76a8f4306d",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "The plant where the staging is performed.",
"disabled": false
},
{
"name": "order",
"value": "",
"description": "The order for which the staging is performed.",
"disabled": false
},
{
"name": "stagingMethod",
"value": "",
"description": "You can specify which type of staging method you want to retrieve: single-order staging or cross-order staging. If you leave this property empty, the system retrieves both single-order staging and cross-order staging methods by default.",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_0eb2d61307f44325ab1deece",
"_type": "request_group",
"name": "Identifiers",
"description": "Create identifiers for the specified event at a plant.",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_aeb7b0514bb74f60bf954682",
"_type": "request",
"name": "Create identifiers.",
"description": "Create identifiers for business objects upon specified events at a plant.",
"method": "POST",
"url": "{{ _.base_url }}/identifiers",
"parentId": "req_0eb2d61307f44325ab1deece",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"eventName\": \"string\",\n \"objectsToMatch\": {\n \"MATERIAL_NAME\": \"string\",\n \"MATERIAL_VERSION\": \"string\",\n \"ORDER_TYPE\": \"string\"\n },\n \"plant\": \"string\"\n}"
}
},
{
"_id": "req_a84e8c1974a4435e8e0e4799",
"_type": "request_group",
"name": "Integration Messages",
"description": "Interact with integration messages in the Manage Integration Dashboard.",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_12efc07bbfcd4a7aa2e603f9",
"_type": "request",
"name": "Finds integration messages.",
"description": "Finds integration messages for given plants, message types, overall statuses, Created On, and Last Updated On.",
"method": "GET",
"url": "{{ _.base_url }}/v1/integrationMessages",
"parentId": "req_a84e8c1974a4435e8e0e4799",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plants",
"value": "",
"description": "Filter for plants.",
"disabled": true
},
{
"name": "messageTypes",
"value": "",
"description": "Filter for message types.",
"disabled": true
},
{
"name": "overallStatuses",
"value": "",
"description": "Filter for overall statuses.",
"disabled": true
},
{
"name": "createdOnFrom",
"value": "",
"description": "Filter for Created On with a start date.",
"disabled": true
},
{
"name": "createdOnTo",
"value": "",
"description": "Filter for Created On with an end date.",
"disabled": true
},
{
"name": "lastUpdatedOnFrom",
"value": "",
"description": "Filter for Last Updated On with a start date.",
"disabled": true
},
{
"name": "lastUpdatedOnTo",
"value": "",
"description": "Filter for Last Updated On with an end date.",
"disabled": true
},
{
"name": "page",
"value": "",
"description": "Page",
"disabled": true
},
{
"name": "size",
"value": "",
"description": "Size",
"disabled": true
},
{
"name": "sort",
"value": "",
"description": "Sort",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_0dcee9483b634745902df461",
"_type": "request",
"name": "Set the indicated integration messages to inactive.",
"description": "Set the indicated integration messages to inactive for the given IDs of integration messages.",
"method": "POST",
"url": "{{ _.base_url }}/v1/integrationMessages/setToInactive",
"parentId": "req_a84e8c1974a4435e8e0e4799",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "[\n \"string\"\n]"
}
},
{
"_id": "req_8a3aaef880f548b685397b77",
"_type": "request_group",
"name": "Inventory",
"description": "Perform inventory relevant activities, such as posting or canceling goods receipts, getting stock information, and updating stock data",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_162baa9acb3c4cf69fee8e22",
"_type": "request",
"name": "Gets posted goods receipts.",
"description": "Gets posted goods receipts that are performed in the Order POD app, the Post-Production Reporting POD app, and with the Goods Receipt public API. The request parameters are case sensitive. As the serial number functionality is not fully supported, thus serial numbers are not returned in this API.",
"method": "GET",
"url": "{{ _.base_url }}/inventory/goodsReceipts",
"parentId": "req_8a3aaef880f548b685397b77",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "The plant where the goods receipts is posted",
"disabled": false
},
{
"name": "order",
"value": "",
"description": "The order number of the goods receipt. You must fill either the order or the SFC to get goods receipts.",
"disabled": true
},
{
"name": "sfc",
"value": "",
"description": "The shop floor control number of the goods receipt. You must fill either the order or the SFC to get goods receipts. If you fill both, the SFC must belong to the order provided. ",
"disabled": true
},
{
"name": "material",
"value": "",
"description": "The material name of the goods receipt",
"disabled": true
},
{
"name": "page",
"value": "",
"description": "The page number you want to query. Number 0 is the first page.",
"disabled": true
},
{
"name": "size",
"value": "",
"description": "The page size determines how many goods receipt postings are displayed in one page.",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_d08790aa53f045e19d718ec1",
"_type": "request",
"name": "Retrieves posted goods issues.",
"description": "Retrieves stock related information of posted goods issues for a given plant and material. You can retrieve goods issues posted to integrated ERP systems and local ones.",
"method": "GET",
"url": "{{ _.base_url }}/inventory/goodsIssues",
"parentId": "req_8a3aaef880f548b685397b77",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "The plant where the goods issue is performed.",
"disabled": false
},
{
"name": "material",
"value": "",
"description": "The material name of the component used in the goods issue.",
"disabled": false
},
{
"name": "materialVersion",
"value": "",
"description": "The material version of the component used in the goods issue.",
"disabled": false
},
{
"name": "batchNumber",
"value": "",
"description": "The batch number of the component used in the goods issue.",
"disabled": true
},
{
"name": "handlingUnit",
"value": "",
"description": "The handling unit number of the innermost package. This property only applies to EWM goods issues.",
"disabled": true
},
{
"name": "inventoryId",
"value": "",
"description": "The inventory ID of the component used in the goods issue.",
"disabled": true
},
{
"name": "order",
"value": "",
"description": "The order against which the goods issue is performed.",
"disabled": true
},
{
"name": "postedBy",
"value": "",
"description": "The user who posted the goods issue.",
"disabled": true
},
{
"name": "productionSupplyArea",
"value": "",
"description": "The production supply area of the component used in the goods issue. This property only applies to EWM goods issues.",
"disabled": true
},
{
"name": "serialNumber",
"value": "",
"description": "The serial number of the component used in the goods issue.",
"disabled": true
},
{
"name": "sfc",
"value": "",
"description": "The shop floor control (SFC) number against which the goods issue is performed. If you've specified an order number, the SFC must belong to that order.",
"disabled": true
},
{
"name": "storageBin",
"value": "",
"description": "The storage bin of the component used in the goods issue. This property only applies to EWM goods issues.",
"disabled": true
},
{
"name": "storageLocation",
"value": "",
"description": "The storage location of the component used in the goods issue.",
"disabled": true
},
{
"name": "workCenter",
"value": "",
"description": "The work center for which the goods issue is performed.",
"disabled": true
},
{
"name": "startDateTime",
"value": "",
"description": "If specified, all goods issues created at or after this UTC time will be retrieved. Format (ISO-8601): yyyy-MM-dd'T'HH:mm:ss.SSS'Z'.",
"disabled": true
},
{
"name": "endDateTime",
"value": "",
"description": "If specified, all goods issues created up to this UTC time will be retrieved. Format (ISO-8601): yyyy-MM-dd'T'HH:mm:ss.SSS'Z'.",
"disabled": true
},
{
"name": "page",
"value": "",
"description": "The page number you want to query. Number 0 is the first page.",
"disabled": true
},
{
"name": "size",
"value": "",
"description": "The size determines how many goods issue postings are displayed in one page.",
"disabled": true
},
{
"name": "sort",
"value": "",
"description": "The retrieved goods issues can be sorted by using one or more of the following properties: 'material', 'order', 'sfc', 'workCenter', 'inventoryId', 'productionSupplyArea', 'storageBin', 'storageLocation', 'batchNumber', 'handlingUnit', 'serialNumber'. By default, the goods issues are sorted by inventory ID in ascending order. For example, https:///inventory/v1/inventory/goodsIssues?plant=&material=&materialVersion=&sort=batchNumber,desc.",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_efe121c6a7f0428da7eee3d0",
"_type": "request",
"name": "Gets stock information for a given plant.",
"description": "Gets stocks that have been created in SAP Digital Manufacturing for a given plant. You can retrieve stocks of different statuses and types, as well as stocks with or without on-hand quantity.",
"method": "GET",
"url": "{{ _.base_url }}/inventories",
"parentId": "req_8a3aaef880f548b685397b77",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "batchNumber",
"value": "",
"description": "The batch number of the stock",
"disabled": true
},
{
"name": "handlingUnit",
"value": "",
"description": "The handling unit number of the innermost package",
"disabled": true
},
{
"name": "inventoryId",
"value": "",
"description": "The inventory ID of the stock",
"disabled": true
},
{
"name": "inventoryIds",
"value": "",
"description": "The inventory IDs of the stocks. You can query a maximum of 50 inventory IDs at one time.",
"disabled": true
},
{
"name": "material",
"value": "",
"description": "The material of the stock",
"disabled": true
},
{
"name": "materialVersion",
"value": "",
"description": "The material version of the stock",
"disabled": true
},
{
"name": "page",
"value": "",
"description": "The page number you want to query. Number 0 is the first page.",
"disabled": true
},
{
"name": "plant",
"value": "",
"description": "The plant of the stock",
"disabled": false
},
{
"name": "productionSupplyArea",
"value": "",
"description": "The production supply area of the stock",
"disabled": true
},
{
"name": "reservedOperation",
"value": "",
"description": "The operation for which the stock is reserved",
"disabled": true
},
{
"name": "reservedOrder",
"value": "",
"description": "The order for which the stock is reserved",
"disabled": true
},
{
"name": "serialNumber",
"value": "",
"description": "The serial number of the stock",
"disabled": true
},
{
"name": "stockRetrieveScope",
"value": "",
"description": "Specify if you want to retrieve stocks with zero quantity. A stock with zero quantity includes but is not limited to stock that once exists in the system, but have zero on-hand quantity due to various reasons. There are 3 possible options: 1) 'ALL': all stock lines are displayed, including stocks with or without non-zero quantity; 2) 'NO_ZERO_STOCK' (default): only stocks with non-zero quantity are displayed; 3) 'ZERO_STOCK': only stocks with zero quantity are displayed.",
"disabled": true
},
{
"name": "size",
"value": "",
"description": "The page size determines how many stocks are displayed in one page. Default page size is 20.",
"disabled": true
},
{
"name": "sort",
"value": "",
"description": "The retrieved stocks can be sorted by using one or more of the following fields: 'inventoryId', 'storageLocation', 'productionSupplyArea', 'storageBin', 'handlingUnit', 'batchNumber' and 'serialNumber'. For example, https:///inventory/v1/inventories?plant=&sort=inventoryId,asc&sort=productionSupplyArea,desc.",
"disabled": true
},
{
"name": "batchesWithStatus",
"value": "",
"description": "Determines whether the restricted status is enabled in the 'status' property.
If set to 'true', the status can be one of the following: 'UNRESTRICTED', 'RESTRICTED', 'QUALITY_INSPECTION' or 'BLOCKED'.
If set to 'false' (default), the status can be 'AVAILABLE', 'HOLD' or 'QUARANTINE'.
We recommend setting it to 'true' for greater flexibility and improved usability.",
"disabled": true
},
{
"name": "status",
"value": "",
"description": "The status of the stock. Only one stock status is allowed per request. The stock has different statuses depending on the value of the 'batchesWithStatus' property.
If the \u2018batchesWithStatus\u2019 property is not provided or set to 'false' (default), there are 3 possible statuses (To be deprecated): 'AVAILABLE', 'HOLD' or 'QUARANTINE'.
If the 'batchesWithStatus' property is set to 'true', there are 4 possible statuses:
1) 'UNRESTRICTED': It corresponds to 'AVAILABLE'.
2) 'RESTRICTED': It also corresponds to 'AVAILABLE'.
3) 'QUALITY_INSPECTION': It corresponds to 'QUARANTINE'.
4) 'BLOCKED': It corresponds to 'HOLD'.
",
"disabled": true
},
{
"name": "storageBin",
"value": "",
"description": "The storage bin where the stock is stored at the production supply area",
"disabled": true
},
{
"name": "storageLocation",
"value": "",
"description": "The storage location of the inventory",
"disabled": true
},
{
"name": "salesOrder",
"value": "",
"description": "The sales order for which the stock is allocated or delivered.",
"disabled": true
},
{
"name": "salesOrderItem",
"value": "",
"description": "The sales order item for which the stock is allocated or delivered. If you provide the salesOrderItem, you also need to specify the salesOrder.",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_f31dc0d61781462ebdd6e42c",
"_type": "request",
"name": "Creates a stock for a given plant and material.",
"description": "Creates a stock with either 'DMC', 'ERP' or 'EWM' origin for a specific material at a given plant. To create stock with 'ERP' or 'EWM' origins, you must first enable Third-Party Inventory Management in the Manage Business Settings app.",
"method": "POST",
"url": "{{ _.base_url }}/inventories",
"parentId": "req_8a3aaef880f548b685397b77",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"material\": \"string\",\n \"materialVersion\": \"string\",\n \"origin\": \"string\",\n \"plant\": \"string\",\n \"quantity\": {\n \"unitOfMeasure\": {\n \"commercialUnitOfMeasure\": \"string\",\n \"internalUnitOfMeasure\": \"string\",\n \"isoUnitOfMeasure\": \"string\"\n },\n \"value\": 0.0\n },\n \"status\": \"string\",\n \"storageLocation\": \"string\"\n}"
}
},
{
"_id": "req_fdd9917dc7d245f1aa0fc780",
"_type": "request",
"name": "Retrieves stock information for a given plant.",
"description": "Retrieves stocks created in SAP Digital Manufacturing for a given plant. You can retrieve stocks of different statuses and types, as well as stocks with or without on-hand quantities. This endpoint differs from the GET /inventories endpoint because you can also retrieve stocks details based on assembly data fields.",
"method": "POST",
"url": "{{ _.base_url }}/inventories/advancedQuery",
"parentId": "req_8a3aaef880f548b685397b77",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"plant\": \"string\"\n}"
}
},
{
"_id": "req_8d17f6ba75c94ddb88feb4ac",
"_type": "request",
"name": "Creates multiple stocks for a given plant.",
"description": "Creates multiple stocks with either 'DMC', 'ERP' or 'EWM' origin for specific materials at a given plant. To create stock with 'ERP' or 'EWM' origins, you must first enable Third-Party Inventory Management in the Manage Business Settings app.",
"method": "POST",
"url": "{{ _.base_url }}/inventories/bulkCreate",
"parentId": "req_8a3aaef880f548b685397b77",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"lineItems\": [\n {\n \"material\": \"string\",\n \"materialVersion\": \"string\",\n \"quantity\": {\n \"unitOfMeasure\": {},\n \"value\": {}\n },\n \"status\": \"string\",\n \"storageLocation\": \"string\"\n }\n ],\n \"origin\": \"string\",\n \"plant\": \"string\"\n}"
}
},
{
"_id": "req_f9c0ae37a39642ce9ca77305",
"_type": "request",
"name": "Posts goods receipts for products in the plant that has enabled Inventory Management.",
"description": "Posts goods receipts for products in the plant where Inventory Management is enabled in SAP Digital Manufacturing Cloud. The goods receipts are posted in both SAP Digital Manufacturing Cloud and the integrated ERP system. You can only post one request lineItem at a time. For the goods receipt filled with serial number, you can only post one product.
Do not use this endpoint in combination with the Work Center POD, Operation Activity POD, or the SFC Complete API. Completing an SFC at the final operation automatically triggers inventory generation, which can result in inconsistencies in the delivered quantity.",
"method": "POST",
"url": "{{ _.base_url }}/inventory/erpGoodsReceipts",
"parentId": "req_8a3aaef880f548b685397b77",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"lineItems\": [\n {\n \"material\": \"string\",\n \"quantity\": {\n \"unitOfMeasure\": {},\n \"value\": {}\n },\n \"sfc\": \"string\"\n }\n ],\n \"order\": \"string\",\n \"plant\": \"string\"\n}"
}
},
{
"_id": "req_7030e48e3c3c4c68926393a2",
"_type": "request",
"name": "Posts goods receipts for products that have enabled Extended Warehouse Management.",
"description": "Posts goods receipts for products in the plant where Extended Warehouse Management is enabled in SAP Digital Manufacturing Cloud. The goods receipts are posted in both SAP Digital Manufacturing Cloud and the integrated EWM system. You can only post one request lineItem at a time. For the goods receipt filled with serial number, you can only post one product.
Do not use this endpoint in combination with the Work Center POD, Operation Activity POD, or the SFC Complete API. Completing an SFC at the final operation automatically triggers inventory generation, which can result in inconsistencies in the delivered quantity.",
"method": "POST",
"url": "{{ _.base_url }}/inventory/ewmGoodsReceipts",
"parentId": "req_8a3aaef880f548b685397b77",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"lineItems\": [\n {\n \"material\": \"string\",\n \"packingMaterial\": \"string\",\n \"quantity\": {\n \"unitOfMeasure\": {},\n \"value\": {}\n },\n \"sfc\": \"string\"\n }\n ],\n \"order\": \"string\",\n \"plant\": \"string\"\n}"
}
},
{
"_id": "req_8c13b8e178f94838a04bda7c",
"_type": "request",
"name": "Gets goods receipt summary.",
"description": "Retrieves the summarized information, such as material, batch number, storage location, of posted goods receipts for a given order or Shop Floor Control. You can retrieve goods receipts managed by both Inventory Management (IM) and Extended Warehouse Management (EWM).",
"method": "GET",
"url": "{{ _.base_url }}/inventory/goodsReceipts/summarize",
"parentId": "req_8a3aaef880f548b685397b77",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "The plant where the goods receipt is performed",
"disabled": false
},
{
"name": "sfc",
"value": "",
"description": "The Shop Floor Control for which the goods receipt is performed",
"disabled": false
},
{
"name": "order",
"value": "",
"description": "The order for which the goods receipt is performed",
"disabled": false
}
],
"authentication": {}
},
{
"_id": "req_cc1bfc0476134270ac4bf1f0",
"_type": "request",
"name": "Cancels goods receipts.",
"description": "Cancels goods receipts that are successfully posted in SAP Digital Manufacturing as well as the integrated ERP system. You can only cancel a single goods receipt at one time.",
"method": "POST",
"url": "{{ _.base_url }}/inventory/goodsReceipts/cancel",
"parentId": "req_8a3aaef880f548b685397b77",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"plant\": \"string\",\n \"transactionIds\": [\n \"string\"\n ]\n}"
}
},
{
"_id": "req_fd10888322ed4e17a551d712",
"_type": "request",
"name": "Gets storage locations for a given plant.",
"description": "Retrieves various types of storage locations for a given plant. You can retrieve storage locations of a particular type, or a specific storage location by its name.",
"method": "GET",
"url": "{{ _.base_url }}/storageLocations",
"parentId": "req_8a3aaef880f548b685397b77",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "isCentralStorageLocation",
"value": "",
"description": "An indicator to specify whether to include central storage location in the query. Fill either isCentralStorageLocation or isProductionStorageLocation to specify the type of storage location you want to retrieve. The two parameters can't be both 'true'.",
"disabled": true
},
{
"name": "isEWMManagedStorageLocation",
"value": "",
"description": "An indicator to specify whether to include storage location managed by Extended Warehouse Management in the query",
"disabled": true
},
{
"name": "isProductionStorageLocation",
"value": "",
"description": "An indicator to specify whether to include production storage location in the query. Fill either isCentralStorageLocation or isProductionStorageLocation to specify the type of storage location you want to retrieve. The two parameters can't be both 'true'.",
"disabled": true
},
{
"name": "page",
"value": "",
"description": "The page number you want to query. Number 0 is the first page.",
"disabled": true
},
{
"name": "plant",
"value": "",
"description": "Plant",
"disabled": false
},
{
"name": "size",
"value": "",
"description": "The page size determines how many storage locations are displayed in one page. Default page size is 20.",
"disabled": true
},
{
"name": "sort",
"value": "",
"description": "The retrieved storage locations can be sorted by 'storageLocation' Example: https:///api/v1/storageLocations?plant=&sort=storageLocation,asc.",
"disabled": true
},
{
"name": "storageLocation",
"value": "",
"description": "Storage Location.",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_a005afd4d67c4f639a2b3c4f",
"_type": "request",
"name": "Updates a single stock for a given plant.",
"description": "Updates an existing stock for a given plant. You can update a stock with DMC, ERP or EWM origin. For DMC stocks, you can increase the stock on-hand quantity, or change the stock information such as stock status and assembly data. For ERP stocks or EWM stocks, you can only change its assembly data. For ERP stocks imported from third-party systems, you can also change the stock details if you've enabled the setting Third-Party Inventory Management and Allow Updating Third-Party Inventories in the Manage Business Settings app.",
"method": "PATCH",
"url": "{{ _.base_url }}/inventories/{inventoryId}",
"parentId": "req_8a3aaef880f548b685397b77",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "The plant of the stock",
"disabled": false
}
],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"lastModifiedDateTime\": \"2024-01-01T00:00:00Z\"\n}"
}
},
{
"_id": "req_a05e1f9231944d559e53197c",
"_type": "request",
"name": "Transfers the full or the partial quantity of a DMC stock to a different storage location.",
"description": "Transfers the full or partial quantity of a stock to a different storage location. It's only supported for stocks with DMC origin or ERP stocks imported from third-party systems.
If you transfer the full quantity, the system creates an inventory ID for the new stock and removes the original stock. However, if you only transfer a partial quantity, the system creates an inventory ID for the new stock while the original stock still exists, just with a decreased quantity. ",
"method": "POST",
"url": "{{ _.base_url }}/inventories/transfer",
"parentId": "req_8a3aaef880f548b685397b77",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"inventoryId\": \"string\",\n \"lastModifiedDateTime\": \"2024-01-01T00:00:00Z\",\n \"plant\": \"string\",\n \"quantity\": {\n \"unitOfMeasure\": {\n \"commercialUnitOfMeasure\": \"string\",\n \"internalUnitOfMeasure\": \"string\",\n \"isoUnitOfMeasure\": \"string\"\n },\n \"value\": 0.0\n },\n \"storageLocation\": \"string\"\n}"
}
},
{
"_id": "req_ff1f29d4397e44158bf432b7",
"_type": "request",
"name": "Retrieves production supply areas.",
"description": "Retrieves production supply areas for a given plant.",
"method": "GET",
"url": "{{ _.base_url }}/productionSupplyAreas",
"parentId": "req_8a3aaef880f548b685397b77",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "The plant of the production supply area.",
"disabled": false
},
{
"name": "productionSupplyArea",
"value": "",
"description": "The name of the production supply area.",
"disabled": true
},
{
"name": "startCreatedDateTime",
"value": "",
"description": "If specified, all production supply areas created at or after this date and time will be retrieved (UTC). Format (ISO-8601): yyyy-MM-dd'T'HH:mm:ss.SSS'Z'.",
"disabled": true
},
{
"name": "endCreatedDateTime",
"value": "",
"description": "If specified, all production supply areas created up to this date and time will be retrieved (UTC). Format (ISO-8601): yyyy-MM-dd'T'HH:mm:ss.SSS'Z'.",
"disabled": true
},
{
"name": "startModifiedDateTime",
"value": "",
"description": "If specified, all production supply areas that's most recently updated at or after this date and time will be retrieved (UTC). Format (ISO-8601): yyyy-MM-dd'T'HH:mm:ss.SSS'Z'.",
"disabled": true
},
{
"name": "endModifiedDateTime",
"value": "",
"description": "If specified, all production supply areas that's most recently updated up to this date and time will be retrieved (UTC). Format (ISO-8601): yyyy-MM-dd'T'HH:mm:ss.SSS'Z'.",
"disabled": true
},
{
"name": "page",
"value": "",
"description": "The page number you want to query. Number 0 is the first page.",
"disabled": true
},
{
"name": "size",
"value": "",
"description": "The size determines how many production supply areas are displayed in one page.",
"disabled": true
},
{
"name": "sort",
"value": "",
"description": "The retrieved production supply areas can be sorted by using one or more of the following properties: 'productionSupplyArea', 'createdDateTime', 'modifiedDateTime'. By default, the production supply areas are sorted by 'productionSupplyArea' in ascending order and 'createdDateTime' in descending order. For example, https:///inventory/v1/productionSupplyAreas?plant=&sort=createdDateTime,desc&sort=productionSupplyArea,asc.",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_254d8782146041fabec776ec",
"_type": "request",
"name": "Creates production supply areas.",
"description": "Creates one or multiple production supply areas for a given plant.",
"method": "POST",
"url": "{{ _.base_url }}/productionSupplyAreas",
"parentId": "req_8a3aaef880f548b685397b77",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"plant\": \"string\",\n \"productionSupplyAreas\": [\n {\n \"productionSupplyArea\": \"string\"\n }\n ]\n}"
}
},
{
"_id": "req_b939794aebee4d2cbcebbcc5",
"_type": "request",
"name": "Synchronizes Extended Warehouse Management (EWM) stock information.",
"description": "Synchronizes stock information from the integrated EWM system to SAP Digital Manufacturing for a given plant, warehouse and production supply area.",
"method": "POST",
"url": "{{ _.base_url }}/inventories/ewmSynchronization",
"parentId": "req_8a3aaef880f548b685397b77",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "async",
"value": "",
"description": "Indicates if the EWM stock synchronization process occurs synchronously or asynchronously. To ensure good API performance, we recommend using the asynchronous process if you retrieve more than 60 stocks items in one call. Stock items are differentiated based on the following properties: plant, warehouse, production supply area (PSA), PSA bin, handling unit, material, order, reservation item number, reservation order number, batch number, serial number and stock type.",
"disabled": true
}
],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"plant\": \"string\",\n \"productionSupplyArea\": \"string\",\n \"warehouse\": \"string\"\n}"
}
},
{
"_id": "req_6387539dc8b743ecbc62cb63",
"_type": "request",
"name": "Retrieves the status of a given transaction.",
"description": "Retrieves the status of a given asynchronous inventory-related transaction, such as the Extended Warehouse Management (EWM) stock synchronization transaction.",
"method": "GET",
"url": "{{ _.base_url }}/inventory/transactions/{id}",
"parentId": "req_8a3aaef880f548b685397b77",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {}
},
{
"_id": "req_bb919b16bd9f4d189e070065",
"_type": "request",
"name": "Returns an ERP origin stock to the central storage location.",
"description": "Returns partial or full quantities of ERP origin stocks to the central storage location for a given plant and inventory ID. Stocks eligible for return don't include those imported from third-party systems. You can return only unrestricted stocks.",
"method": "POST",
"url": "{{ _.base_url }}/inventories/{inventoryId}/return",
"parentId": "req_8a3aaef880f548b685397b77",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "The plant of the stock.",
"disabled": false
}
],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"destinationStorageLocation\": \"string\",\n \"quantity\": {\n \"unitOfMeasure\": {\n \"commercialUnitOfMeasure\": \"string\",\n \"internalUnitOfMeasure\": \"string\",\n \"isoUnitOfMeasure\": \"string\"\n },\n \"value\": 0.0\n }\n}"
}
},
{
"_id": "req_299e6ad601e64285b9bc5d8e",
"_type": "request",
"name": "Scraps an ERP origin stock.",
"description": "Scraps partial or full quantities of ERP origin stocks for a given plant and inventory ID. Stocks eligible for scrap don't include those imported from third-party systems. You can scrap only unrestricted stocks.",
"method": "POST",
"url": "{{ _.base_url }}/inventories/{inventoryId}/scrap",
"parentId": "req_8a3aaef880f548b685397b77",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "The plant of the stock.",
"disabled": false
}
],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"quantity\": {\n \"unitOfMeasure\": {\n \"commercialUnitOfMeasure\": \"string\",\n \"internalUnitOfMeasure\": \"string\",\n \"isoUnitOfMeasure\": \"string\"\n },\n \"value\": 0.0\n }\n}"
}
},
{
"_id": "req_1030014e36da4013aae2f8af",
"_type": "request",
"name": "Clear inventories by specific plant and inventory IDs.",
"description": "Clear inventories for a given plant and inventory IDs. The on hand quantity for specified inventories will be zero after they are cleared. It is possible to clear inventories of all origins (DM, ERP, and EWM).",
"method": "POST",
"url": "{{ _.base_url }}/inventories/clear",
"parentId": "req_8a3aaef880f548b685397b77",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "The plant of the stock.",
"disabled": false
},
{
"name": "inventoryIds",
"value": "",
"description": "The inventory IDs of the stock that needs to be cleared.",
"disabled": false
}
],
"authentication": {}
},
{
"_id": "req_51555a5a31a44b31a8e06236",
"_type": "request_group",
"name": "Inventory",
"description": "Perform inventory relevant activities, such as retrieving stock information and updating stock data.",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_3492cff2ba744e0385da976b",
"_type": "request",
"name": "Retrieves stock information for a given plant.",
"description": "Retrieves stocks created in SAP Digital Manufacturing for a given plant. You can retrieve stocks of different statuses and types, as well as stocks with or without on-hand quantities.",
"method": "POST",
"url": "{{ _.base_url }}/inventories/query",
"parentId": "req_51555a5a31a44b31a8e06236",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"plant\": \"string\"\n}"
}
},
{
"_id": "req_954af685217148a6b2bcf82d",
"_type": "request",
"name": "Creates multiple stocks for a given plant.",
"description": "Creates multiple stocks with either 'DMC', 'ERP' or 'EWM' origin for specific materials at a given plant. To create stock with 'ERP' or 'EWM' origins, you must first enable Third-Party Inventory Management in the Manage Business Settings app.",
"method": "POST",
"url": "{{ _.base_url }}/inventories/bulkCreate",
"parentId": "req_51555a5a31a44b31a8e06236",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"lineItems\": [\n {\n \"material\": \"string\",\n \"materialVersion\": \"string\",\n \"quantity\": {\n \"unitOfMeasure\": {},\n \"value\": {}\n },\n \"status\": \"string\",\n \"storageLocation\": \"string\"\n }\n ],\n \"origin\": \"string\",\n \"plant\": \"string\"\n}"
}
},
{
"_id": "req_8cc2d0d64f55425aadf646f8",
"_type": "request",
"name": "Updates a single stock for a given plant.",
"description": "Updates an existing stock for a given plant. You can update a stock with DMC, ERP or EWM origin. For DMC stocks, you can increase the stock on-hand quantity, or change the stock information such as stock status and data fields. For ERP stocks or EWM stocks, you can only change its data fields. For the stocks imported from third-party systems(Stocks originally created via POST /api/v2/inventories/bulkCreate), you can also change the stock details if the settings Third-Party Inventory Management and Allow Updating Third-Party Inventories are enabled in the Manage Business Settings app.",
"method": "PATCH",
"url": "{{ _.base_url }}/inventories/{inventoryId}",
"parentId": "req_51555a5a31a44b31a8e06236",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "The plant of the stock",
"disabled": false
}
],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"lastModifiedDateTime\": \"2024-01-01T00:00:00Z\"\n}"
}
},
{
"_id": "req_93a8ffdb5d2d4547bb8690da",
"_type": "request",
"name": "Transfers the full or the partial quantity of a DMC stock to a different storage location.",
"description": "Transfers the full or partial quantity of a stock to a different storage location. It's only supported for stocks with DMC origin or ERP stocks imported from third-party systems.
If you transfer the full quantity, the system creates an inventory ID for the new stock and removes the original stock. However, if you only transfer a partial quantity, the system creates an inventory ID for the new stock while the original stock still exists, just with a decreased quantity. ",
"method": "POST",
"url": "{{ _.base_url }}/inventories/transfer",
"parentId": "req_51555a5a31a44b31a8e06236",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"inventoryId\": \"string\",\n \"lastModifiedDateTime\": \"2024-01-01T00:00:00Z\",\n \"plant\": \"string\",\n \"quantity\": {\n \"unitOfMeasure\": {\n \"commercialUnitOfMeasure\": \"string\",\n \"internalUnitOfMeasure\": \"string\",\n \"isoUnitOfMeasure\": \"string\"\n },\n \"value\": 0.0\n },\n \"storageLocation\": \"string\"\n}"
}
},
{
"_id": "req_da2595a5fe114eee8d751758",
"_type": "request",
"name": "Synchronizes Extended Warehouse Management (EWM) stock information.",
"description": "Synchronizes stock information from the integrated EWM system to SAP Digital Manufacturing for a given plant, warehouse and production supply area.",
"method": "POST",
"url": "{{ _.base_url }}/inventories/ewmSynchronization",
"parentId": "req_51555a5a31a44b31a8e06236",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "async",
"value": "",
"description": "Indicates if the EWM stock synchronization process occurs synchronously or asynchronously. To ensure good API performance, we recommend using the asynchronous process if you retrieve more than 60 stocks items in one call. Stock items are differentiated based on the following properties: plant, warehouse, production supply area (PSA), PSA bin, handling unit, material, order, reservation item number, reservation order number, batch number, serial number and stock type.",
"disabled": true
}
],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"plant\": \"string\",\n \"productionSupplyArea\": \"string\",\n \"warehouse\": \"string\"\n}"
}
},
{
"_id": "req_0773ed04058f46b5ab69e8b3",
"_type": "request",
"name": "Returns an ERP origin stock to the central storage location.",
"description": "Returns partial or full quantities of ERP origin stocks to the central storage location for a given plant and inventory ID. Stocks eligible for return don't include those imported from third-party systems. You can return only unrestricted stocks.",
"method": "POST",
"url": "{{ _.base_url }}/inventories/{inventoryId}/return",
"parentId": "req_51555a5a31a44b31a8e06236",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "The plant of the stock.",
"disabled": false
}
],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"destinationStorageLocation\": \"string\",\n \"quantity\": {\n \"unitOfMeasure\": {\n \"commercialUnitOfMeasure\": \"string\",\n \"internalUnitOfMeasure\": \"string\",\n \"isoUnitOfMeasure\": \"string\"\n },\n \"value\": 0.0\n }\n}"
}
},
{
"_id": "req_6176e51c70fb4287bb7358e6",
"_type": "request",
"name": "Scraps an ERP origin stock.",
"description": "Scraps partial or full quantities of ERP origin stocks for a given plant and inventory ID. Stocks eligible for scrap don't include those imported from third-party systems. You can scrap only unrestricted stocks.",
"method": "POST",
"url": "{{ _.base_url }}/inventories/{inventoryId}/scrap",
"parentId": "req_51555a5a31a44b31a8e06236",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "The plant of the stock.",
"disabled": false
}
],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"quantity\": {\n \"unitOfMeasure\": {\n \"commercialUnitOfMeasure\": \"string\",\n \"internalUnitOfMeasure\": \"string\",\n \"isoUnitOfMeasure\": \"string\"\n },\n \"value\": 0.0\n }\n}"
}
},
{
"_id": "req_a816f727bbff4844a7ab1935",
"_type": "request",
"name": "Posts goods receipts for products that have enabled Extended Warehouse Management.",
"description": "Posts goods receipts for products in plants where Extended Warehouse Management is enabled in SAP Digital Manufacturing Cloud. The goods receipts are created in both SAP Digital Manufacturing Cloud and the integrated EWM system. The API supports posting a single request with multiple line items, where each line item can include multiple serial numbers. A maximum of 50-line items per request is allowed, with an overall limit of 500 serial numbers per request. Do not use this endpoint in combination with the Work Center POD, Operation Activity POD, or the SFC Complete API. Completing an SFC at the final operation automatically triggers inventory generation, which can result in inconsistencies in the delivered quantity.",
"method": "POST",
"url": "{{ _.base_url }}/inventory/ewmGoodsReceipts",
"parentId": "req_51555a5a31a44b31a8e06236",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"lineItems\": [\n {\n \"material\": \"string\",\n \"packingMaterial\": \"string\",\n \"quantity\": {\n \"unitOfMeasure\": {},\n \"value\": {}\n },\n \"sfc\": \"string\"\n }\n ],\n \"order\": \"string\",\n \"plant\": \"string\"\n}"
}
},
{
"_id": "req_7518af23f78f4f35bc22e641",
"_type": "request",
"name": "Retrieves posted goods receipts.",
"description": "Retrieves posted goods receipts from the Order POD app, Post-Production Reporting POD app, and the Goods Receipt public API. Please note that the request parameters are case-sensitive.",
"method": "GET",
"url": "{{ _.base_url }}/inventory/goodsReceipts",
"parentId": "req_51555a5a31a44b31a8e06236",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "The plant where the goods receipts is posted",
"disabled": false
},
{
"name": "order",
"value": "",
"description": "The order number of the goods receipt. You must fill either the order or the SFC to get goods receipts.",
"disabled": true
},
{
"name": "sfc",
"value": "",
"description": "The Shop Floor Control (SFC) number for the goods receipt. You must provide either the Order or the SFC to retrieve goods receipts. If both are provided, the SFC must correspond to the specified order.",
"disabled": true
},
{
"name": "material",
"value": "",
"description": "The material name of the goods receipt",
"disabled": true
},
{
"name": "showRelevantGoodsReceiptItems",
"value": "",
"description": "Whether to include all other items within the same transaction, even if they do not match the specified material or SFC filters.",
"disabled": true
},
{
"name": "page",
"value": "",
"description": "The page number you want to query. Number 0 is the first page.",
"disabled": true
},
{
"name": "size",
"value": "",
"description": "The page size determines how many goods receipt postings are returned per page. An internal validation limits the maximum value to 100. If not specified, the default value is 20.",
"disabled": true
},
{
"name": "sort",
"value": "",
"description": "The retrieved goods receipts can be sorted using one or more of the following fields: 'postedBy', 'postingDateTime' and 'createdDateTime'. Example: 'https://xxx/v2/inventory/goodsReceipts?xxxx&sort=postingDateTime,desc&sort=createdDateTime,asc'. The default sorting order is descending, and the default sort fields are 'postingDateTime' and 'createdDateTime'.",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_7a284b2e84654d23addef48d",
"_type": "request",
"name": "Retrieves posted goods issues.",
"description": "Retrieves stock related information of posted goods issues for a given plant and material. You can retrieve goods issues posted to integrated ERP systems and local ones.",
"method": "GET",
"url": "{{ _.base_url }}/inventory/goodsIssues",
"parentId": "req_51555a5a31a44b31a8e06236",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "The plant where the goods issue is performed.",
"disabled": false
},
{
"name": "material",
"value": "",
"description": "The material name of the component used in the goods issue.",
"disabled": false
},
{
"name": "materialVersion",
"value": "",
"description": "The material version of the component used in the goods issue.",
"disabled": false
},
{
"name": "batchNumber",
"value": "",
"description": "The batch number of the component used in the goods issue.",
"disabled": true
},
{
"name": "handlingUnit",
"value": "",
"description": "The handling unit number of the innermost package. This property only applies to EWM goods issues.",
"disabled": true
},
{
"name": "inventoryId",
"value": "",
"description": "The inventory ID of the component used in the goods issue.",
"disabled": true
},
{
"name": "order",
"value": "",
"description": "The order against which the goods issue is performed.",
"disabled": true
},
{
"name": "postedBy",
"value": "",
"description": "The user who posted the goods issue.",
"disabled": true
},
{
"name": "productionSupplyArea",
"value": "",
"description": "The production supply area of the component used in the goods issue. This property only applies to EWM goods issues.",
"disabled": true
},
{
"name": "serialNumber",
"value": "",
"description": "The serial number of the component used in the goods issue.",
"disabled": true
},
{
"name": "sfc",
"value": "",
"description": "The shop floor control (SFC) number against which the goods issue is performed. If you've specified an order number, the SFC must belong to that order.",
"disabled": true
},
{
"name": "storageBin",
"value": "",
"description": "The storage bin of the component used in the goods issue. This property only applies to EWM goods issues.",
"disabled": true
},
{
"name": "storageLocation",
"value": "",
"description": "The storage location of the component used in the goods issue.",
"disabled": true
},
{
"name": "workCenter",
"value": "",
"description": "The work center for which the goods issue is performed.",
"disabled": true
},
{
"name": "startDateTime",
"value": "",
"description": "If specified, all goods issues posted at or after this UTC time will be retrieved. Format (ISO-8601): yyyy-MM-dd'T'HH:mm:ss.SSS'Z'.",
"disabled": true
},
{
"name": "endDateTime",
"value": "",
"description": "If specified, all goods issues posted up to this UTC time will be retrieved. Format (ISO-8601): yyyy-MM-dd'T'HH:mm:ss.SSS'Z'.",
"disabled": true
},
{
"name": "page",
"value": "",
"description": "The page number you want to query. Number 0 is the first page.",
"disabled": true
},
{
"name": "size",
"value": "",
"description": "The size determines how many goods issue postings are displayed in one page. An internal validation limits the maximum value to 100. If not specified, the default value is 20.",
"disabled": true
},
{
"name": "sort",
"value": "",
"description": "The retrieved goods issues can be sorted by using one or more of the following properties: 'order', 'sfc', 'workCenter', 'inventoryId', 'productionSupplyArea', 'storageBin', 'storageLocation', 'batchNumber', 'handlingUnit', 'serialNumber'. By default, the goods issues are sorted by inventory ID in ascending order. For example, https:///inventory/v2/inventory/goodsIssues?plant=&material=&materialVersion=&sort=batchNumber,desc.",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_8c7b575eec3347d4b744b01b",
"_type": "request_group",
"name": "Issues",
"description": "Allows you to create and read issues in SAP Digital Manufacturing for Issue Resolution.",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_728576b2a391410f9ff9977b",
"_type": "request",
"name": "Retrieves a list of issues.",
"description": "Retrieves a list of issues.",
"method": "GET",
"url": "{{ _.base_url }}/Issues",
"parentId": "req_8c7b575eec3347d4b744b01b",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "$filter",
"value": "",
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
"disabled": true
},
{
"name": "$orderby",
"value": "",
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
"disabled": true
},
{
"name": "$select",
"value": "",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"disabled": true
},
{
"name": "$expand",
"value": "",
"description": "The value of $expand query option is a comma-separated list of navigation property names, stream property names, or $value indicating the stream content of a media-entity. The corresponding related entities and stream values will be represented inline, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_0896b02d7743497c8da59dc1",
"_type": "request",
"name": "Creates an issue.",
"description": "Creates an issue.",
"method": "POST",
"url": "{{ _.base_url }}/Issues",
"parentId": "req_8c7b575eec3347d4b744b01b",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"descriptionShort\": \"string\",\n \"sourceSystemId\": \"string\"\n}"
}
},
{
"_id": "req_e5149f573d7c4f089b03c314",
"_type": "request",
"name": "Retrieves all values of an issue.",
"description": "Retrieves all values of an issue.",
"method": "GET",
"url": "{{ _.base_url }}/Issues('{issueId}')",
"parentId": "req_8c7b575eec3347d4b744b01b",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "$select",
"value": "",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"disabled": true
},
{
"name": "$expand",
"value": "",
"description": "The value of $expand query option is a comma-separated list of navigation property names, stream property names, or $value indicating the stream content of a media-entity. The corresponding related entities and stream values will be represented inline, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_dbe797b79ba24e219d5d4468",
"_type": "request_group",
"name": "Labor",
"description": "Retrieves the shift assignments including non-availability of assigned labors.",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_0d4abf1d7d9e47b5a81e2485",
"_type": "request",
"name": "Retrieves labor shift assignments for a plant within a specified date range, with optional filters for shift and supervisor.",
"description": "Fetches labor shift assignments, including non-availability, for shop floor supervisors in a specified plant over a defined date range. You may apply optional filters for shift and supervisor to narrow the results, or omit them to retrieve all assignments within the given period.",
"method": "POST",
"url": "{{ _.base_url }}/laborshiftplans",
"parentId": "req_dbe797b79ba24e219d5d4468",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"endDate\": \"string\",\n \"plant\": \"string\",\n \"startDate\": \"string\"\n}"
}
},
{
"_id": "req_c3ad9e093f2d4299af4ee165",
"_type": "request",
"name": "Assigns shifts and work centers to selected workforce.",
"description": "This endpoint assigns specified shifts and work centers to a list of workforce for a given plant and supervisor, within a defined date range. It allows shift planning based on operational needs and supports optional assignment of work centers.",
"method": "POST",
"url": "{{ _.base_url }}/labors/shift-assignment",
"parentId": "req_dbe797b79ba24e219d5d4468",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"endDate\": \"string\",\n \"plant\": \"string\",\n \"shiftAssignments\": [\n {\n \"labor\": [\n {}\n ],\n \"shift\": \"string\"\n }\n ],\n \"startDate\": \"string\",\n \"supervisor\": \"string\"\n}"
}
},
{
"_id": "req_f938e7bb01fb4175875b753c",
"_type": "request_group",
"name": "Labor Management",
"description": "Manage labor information in SAP Digital Manufacturing",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_0258655ffe4943cba65db045",
"_type": "request",
"name": "Retrieves the list of labor skills.",
"description": "Retrieves the list of labor skills available in the system.",
"method": "GET",
"url": "{{ _.base_url }}/LaborSkills",
"parentId": "req_f938e7bb01fb4175875b753c",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "Plant for which the request is executed",
"disabled": false
},
{
"name": "supervisorId",
"value": "",
"description": "Supervisor for which the request is executed",
"disabled": false
},
{
"name": "$filter",
"value": "",
"description": "Filter items by property values. For more information, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_f37bc08ae48f4e15a0b1b0e5",
"_type": "request_group",
"name": "Last Indicator Value",
"description": "Last value for an Indicator",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_b8e5db273e2c40c3a6f9ac80",
"_type": "request",
"name": "Saves the indicator's last value.",
"description": "Send and save the indicator's last value from shop floor via Production Connector for SAP Digital Manufacturing.",
"method": "POST",
"url": "{{ _.base_url }}/value",
"parentId": "req_f37bc08ae48f4e15a0b1b0e5",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"assetId\": \"string\",\n \"indicator\": \"string\",\n \"plant\": \"string\",\n \"value\": \"string\",\n \"workCenter\": \"string\"\n}"
}
},
{
"_id": "req_48ddb67447ce4307b4c30f1c",
"_type": "request_group",
"name": "Logistics",
"description": "Perform logistics order relevant activities, such as creating orders and updating order status",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_e0ce0c1f077544d4bd2afac6",
"_type": "request",
"name": "Updates logistics order status to Accepted status or or Ready for Pick status",
"description": "With this endpoint call, a logistics order is updated to Accepted status or Ready for Pick status by specific processor or an integrated third-party transport system. Only this processor or relative third-party transport system can further execute the logistics order. Depending on the reference type of the logistics order, the status is updated as follows: If the reference type is packing unit, the status is updated to Accepted when the packing unit is still open, and to Ready for Pick when the packing unit is already closed. If the reference type is shop floor control (SFC), the status is updated to Ready for Pick when the operation is completed on the source location, and to Accepted status in all the other cases. If the reference type is carrier, the status is updated to Ready for Pick.",
"method": "POST",
"url": "{{ _.base_url }}/execution/acceptLogisticsOrder",
"parentId": "req_48ddb67447ce4307b4c30f1c",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"id\": \"string\",\n \"keyType\": \"string\",\n \"plant\": \"string\"\n}"
}
},
{
"_id": "req_adae6f9170df4fbc9a1c28de",
"_type": "request",
"name": "Updates logistics order status to Confirmed.",
"description": "With this endpoint call, a logistics order is updated to Confirmed status by specific processor or integrated third-party transport systems.Confirmed status means the order has finished the transportation from the source location to the destination location, and thus it's done.",
"method": "POST",
"url": "{{ _.base_url }}/execution/confirmLogisticsOrder",
"parentId": "req_48ddb67447ce4307b4c30f1c",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"destinationLocation\": \"string\",\n \"id\": \"string\",\n \"keyType\": \"string\",\n \"plant\": \"string\"\n}"
}
},
{
"_id": "req_97e1db3e52ba4f2a93961ac6",
"_type": "request",
"name": "Updates logistics order status to Picked.",
"description": "With this endpoint call, a logistics order is updated to Picked status by specific processor or integrated third-party transport systems. Picked status means the processor has already picked items for the logistics order. Only this processor can further execute the logistics order.",
"method": "POST",
"url": "{{ _.base_url }}/execution/pickLogisticsOrder",
"parentId": "req_48ddb67447ce4307b4c30f1c",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"id\": \"string\",\n \"keyType\": \"string\",\n \"plant\": \"string\"\n}"
}
},
{
"_id": "req_bbb6db1859f54ab7978bbebb",
"_type": "request",
"name": "Creates a logistics order.",
"description": "Creates a logistics order for a given shop floor control (SFC), packing unit or carrier.",
"method": "POST",
"url": "{{ _.base_url }}/createLogisticsOrder",
"parentId": "req_48ddb67447ce4307b4c30f1c",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"destinationLocation\": \"string\",\n \"destinationType\": \"string\",\n \"plant\": \"string\",\n \"referenceNumber\": \"string\",\n \"referenceType\": \"string\",\n \"sourceLocation\": \"string\",\n \"sourceType\": \"string\"\n}"
}
},
{
"_id": "req_e9476c52b59f40049659bc56",
"_type": "request",
"name": "Retrieves logistics orders.",
"description": "Retrieves logistics orders by order number, reference number or carrier ID.",
"method": "GET",
"url": "{{ _.base_url }}/readLogisticsOrder",
"parentId": "req_48ddb67447ce4307b4c30f1c",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "The plant of the logistics order",
"disabled": false
},
{
"name": "id",
"value": "",
"description": "The ID is used for retrieving logistics order. There are 3 possible types of ID: CARRIER_ID, ORDER_NUMBER and REFERENCE_NUMBER",
"disabled": false
},
{
"name": "keyType",
"value": "",
"description": "Specify the type of ID that is used for the operation. There are 3 possible types: CARRIER_ID, ORDER_NUMBER and REFERENCE_NUMBER",
"disabled": false
},
{
"name": "referenceType",
"value": "",
"description": "The reference type of the logistics order. There are 3 possible types: shop floor control (SFC), packing unit or carrier.",
"disabled": true
},
{
"name": "status",
"value": "",
"description": "The status of the logistics order. There are the following possible statuses: 'NEW', 'OPEN', 'ACCEPTED', 'READY_FOR_PICK', 'REJECTED','PICKED', 'CONFIRMED', 'CANCELLED', 'HOLD'.",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_c863090cd91d4d91b2cfba30",
"_type": "request",
"name": "Updates logistics order status to Hold.",
"description": "With this endpoint call, a logistics order is updated to Hold status by a specific supervisor. Hold status means the logistics order is no longer active.",
"method": "POST",
"url": "{{ _.base_url }}/holdLogisticsOrder",
"parentId": "req_48ddb67447ce4307b4c30f1c",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"orderNumber\": \"string\",\n \"plant\": \"string\"\n}"
}
},
{
"_id": "req_1894fcd5b39c486084660e28",
"_type": "request",
"name": "Updates logistics order status to Canceled.",
"description": "With this endpoint call, a logistics order is updated to Canceled status by a specific supervisor. Canceled status means the logistics order is no longer active.",
"method": "POST",
"url": "{{ _.base_url }}/cancelLogisticsOrder",
"parentId": "req_48ddb67447ce4307b4c30f1c",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"orderNumber\": \"string\",\n \"plant\": \"string\"\n}"
}
},
{
"_id": "req_a73f6d82cfbe4a0697e8a5d6",
"_type": "request",
"name": "Updates logistics order status to Rejected.",
"description": "With this endpoint call, a logistics order is updated to Rejected status by a specific processor or an integrated third-party transport system. If it\u2019s rejected by a specific processor, it is now available to be accepted again by another operator. If it\u2019s rejected by a third-party transport system, it can be accepted again only after the supervisor has done some necessary adjustments to the logistics order.",
"method": "POST",
"url": "{{ _.base_url }}/execution/rejectLogisticsOrder",
"parentId": "req_48ddb67447ce4307b4c30f1c",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"id\": \"string\",\n \"keyType\": \"string\",\n \"plant\": \"string\"\n}"
}
},
{
"_id": "req_a4d20c7de98b45618b121f22",
"_type": "request",
"name": "Updates logistics order status when an operation is completed",
"description": "Sends a Kafka message when a given operation is completed for the shop floor control (SFC) at a specified resource or work center.This API endpoint triggers Kafka message to announce SFC complete event. Respective consumer service catches this event and updates logistics order with New status to Open status, or Accepted status to Ready for Pick status.",
"method": "POST",
"url": "{{ _.base_url }}/sfcComplete/sendLogisticsOrderEvent",
"parentId": "req_48ddb67447ce4307b4c30f1c",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"operation\": \"string\",\n \"plant\": \"string\",\n \"sfcs\": [\n \"string\"\n ]\n}"
}
},
{
"_id": "req_824ff8249dc3436aadcd373b",
"_type": "request",
"name": "Updates a logistics order.",
"description": "Updates the destination and the delivery due date time of a logistics order. You can only update the logistics order that has NEW, OPEN, HOLD or REJECTED status.",
"method": "PATCH",
"url": "{{ _.base_url }}/execution/updateLogisticsOrder",
"parentId": "req_48ddb67447ce4307b4c30f1c",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"id\": \"string\",\n \"keyType\": \"string\",\n \"plant\": \"string\"\n}"
}
},
{
"_id": "req_58015677a1344401acabc11c",
"_type": "request_group",
"name": "Manage Identifiers Configuration",
"description": "Create and maintain Identifiers configuration",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_b3851d5a3ad44e459c2426f9",
"_type": "request",
"name": "Read identifiers configuration.",
"description": "With this operation, identifiers configuration for business objects upon specified events at a plant can be retrieved.",
"method": "GET",
"url": "{{ _.base_url }}/config",
"parentId": "req_58015677a1344401acabc11c",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "Plant to read an identifier configuration.",
"disabled": false
},
{
"name": "id",
"value": "",
"description": "Request ID to retrieve an identifier configuration.",
"disabled": false
}
],
"authentication": {}
},
{
"_id": "req_ac4892c3ab814789a4f4c8df",
"_type": "request",
"name": "Create identifiers configuration.",
"description": "With this operation, identifiers configuration for business objects upon specified events at a plant can be created.",
"method": "POST",
"url": "{{ _.base_url }}/config",
"parentId": "req_58015677a1344401acabc11c",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"currentSequence\": \"string\",\n \"nextNumberType\": \"string\",\n \"plant\": \"string\",\n \"sequenceBase\": 0.0,\n \"sourceSystem\": \"string\"\n}"
}
},
{
"_id": "req_ba538bfdbafe44168e2797b5",
"_type": "request",
"name": "Update identifiers configuration.",
"description": "With this operation, identifiers configuration for business objects upon specified events at a plant can be updated.",
"method": "PUT",
"url": "{{ _.base_url }}/config",
"parentId": "req_58015677a1344401acabc11c",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"currentSequence\": \"string\",\n \"id\": \"string\",\n \"plant\": \"string\",\n \"sequenceBase\": 0.0,\n \"sourceSystem\": \"string\"\n}"
}
},
{
"_id": "req_dc86bbb0ffea4dab8cf2ad3e",
"_type": "request",
"name": "Delete identifiers configuration.",
"description": "With this operation, identifiers configuration for business objects upon specified events at a plant can be deleted.",
"method": "DELETE",
"url": "{{ _.base_url }}/config",
"parentId": "req_58015677a1344401acabc11c",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "Plant to delete an identifier configuration.",
"disabled": false
},
{
"name": "id",
"value": "",
"description": "Request ID to delete an identifier configuration.",
"disabled": false
}
],
"authentication": {}
},
{
"_id": "req_475be19e9d6742a5a4dd89b3",
"_type": "request",
"name": "Read all identifiers configurations.",
"description": "With this operation, you can retrieve all identifiers configurations for the specified event at a plant. You can define the event types like SFC Release, SFC Serialize etc.",
"method": "GET",
"url": "{{ _.base_url }}/materialIdentifierConfigurations",
"parentId": "req_58015677a1344401acabc11c",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "Plant to read identifier configurations.",
"disabled": false
},
{
"name": "event",
"value": "",
"description": "Read Identifier Configurations based on event types like SFC Release, SFC Serialize etc. ",
"disabled": false
}
],
"authentication": {}
},
{
"_id": "req_000b05acdf794a1d84ae4be1",
"_type": "request_group",
"name": "Master Operation",
"description": "Search and view information about master operations",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_8e2405e97ed347acba9402f4",
"_type": "request",
"name": "Finds a master operation activity by activityId, plant and order name or SFC name",
"description": "Retrieves master operation activity for the provided activityId, plant and order name or SFC name.",
"method": "GET",
"url": "{{ _.base_url }}/masterOperation",
"parentId": "req_000b05acdf794a1d84ae4be1",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "activityId",
"value": "",
"description": "Routing activity id for which request is executed",
"disabled": false
},
{
"name": "order",
"value": "",
"description": "Order for which request is executed. Either order or SFC must be specified.",
"disabled": true
},
{
"name": "plant",
"value": "",
"description": "Plant for which request is executed",
"disabled": false
},
{
"name": "routing",
"value": "",
"description": "Routing name for which request is executed",
"disabled": false
},
{
"name": "routingType",
"value": "",
"description": "Routing type. \nPossible values: \nPRODUCTION - Production Router; \nSHOP_ORDER - Shop Order-specific Router; \nSPECIAL - Special Operation Router; \nNC - NC (Rework) Router); \nDISPOSITION - Disposition Router (used in disposition groups); \nCONFIGURABLE - Configurable Router Type.",
"disabled": false
},
{
"name": "routingVersion",
"value": "",
"description": "Routing version for which request is executed",
"disabled": false
},
{
"name": "sfc",
"value": "",
"description": "SFC name for which request is executed. Either order or SFC must be specified.",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_bdf05ac73e9c4adda8589889",
"_type": "request_group",
"name": "Material",
"description": "Browse and modify materials",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_f8d5070162354b6082b63ee7",
"_type": "request",
"name": "Find material.",
"description": "Finds a material by plant, name, and version.",
"method": "GET",
"url": "{{ _.base_url }}/v1/materials",
"parentId": "req_bdf05ac73e9c4adda8589889",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "material",
"value": "",
"description": "Material name",
"disabled": false
},
{
"name": "plant",
"value": "",
"description": "Plant for which the request is executed",
"disabled": false
},
{
"name": "version",
"value": "",
"description": "Version of the material. If not present, current version material will be returned.",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_55303e88a2154d8ca8f29d4d",
"_type": "request",
"name": "Create material.",
"description": "Creates a list of materials for given plants.",
"method": "POST",
"url": "{{ _.base_url }}/v1/materials",
"parentId": "req_bdf05ac73e9c4adda8589889",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "[\n {\n \"alternateUnitsOfMeasure\": [\n {\n \"denominator\": {},\n \"numerator\": {},\n \"parallelUom\": {},\n \"uom\": {}\n }\n ],\n \"assemblyDataType\": {\n \"category\": \"string\",\n \"dataFieldList\": [\n {}\n ],\n \"dataType\": \"string\",\n \"description\": \"string\"\n },\n \"bom\": {\n \"bom\": \"string\",\n \"bomType\": \"string\",\n \"plant\": \"string\",\n \"version\": \"string\"\n },\n \"bomExplosionDependent\": \"string\",\n \"createdDateTime\": \"2024-01-01T00:00:00Z\",\n \"customValues\": [\n {\n \"attribute\": {},\n \"value\": {}\n }\n ],\n \"description\": \"string\",\n \"descriptions\": [\n {\n \"description\": {},\n \"locale\": {}\n }\n ],\n \"isAutocompleteAndConfirmed\": true,\n \"isCurrentVersion\": true,\n \"locations\": [\n {\n \"description\": {},\n \"location\": {},\n \"locationData\": {}\n }\n ],\n \"lotSize\": 0.0,\n \"material\": \"string\",\n \"materialGroups\": [\n \"string\"\n ],\n \"materialType\": \"string\",\n \"maxShelfLife\": 0.0,\n \"maxShelfLifeUnits\": \"string\",\n \"modifiedDateTime\": \"2024-01-01T00:00:00Z\",\n \"mrpController\": \"string\",\n \"orderProcessingMode\": \"string\",\n \"origin\": \"string\",\n \"panel\": true,\n \"plant\": \"string\",\n \"procurementType\": \"string\",\n \"productionStorageLocation\": \"string\",\n \"putawayStorageLocation\": \"string\",\n \"quantityRestriction\": \"string\",\n \"removalComponentDataType\": {\n \"category\": \"string\",\n \"dataFieldList\": [\n {}\n ],\n \"dataType\": \"string\",\n \"description\": \"string\"\n },\n \"routing\": {\n \"plant\": \"string\",\n \"routing\": \"string\",\n \"routingType\": \"string\",\n \"version\": \"string\"\n },\n \"serialNumberProfile\": \"string\",\n \"status\": \"string\",\n \"targetLotSize\": 0.0,\n \"unitOfMeasure\": \"string\",\n \"version\": \"string\"\n }\n]"
}
},
{
"_id": "req_87601e6e0efc471eb10bfd4b",
"_type": "request",
"name": "Update material.",
"description": "Every material that will be updated must have the material, plant, and version fields specified. Only the specified fields will be updated. Any unspecified fields will remain unchanged.",
"method": "PATCH",
"url": "{{ _.base_url }}/v1/materials",
"parentId": "req_bdf05ac73e9c4adda8589889",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "[\n {\n \"alternateUnitsOfMeasure\": [\n {\n \"denominator\": {},\n \"numerator\": {},\n \"parallelUom\": {},\n \"uom\": {}\n }\n ],\n \"assemblyDataType\": {\n \"category\": \"string\",\n \"dataFieldList\": [\n {}\n ],\n \"dataType\": \"string\",\n \"description\": \"string\"\n },\n \"bom\": {\n \"bom\": \"string\",\n \"bomType\": \"string\",\n \"plant\": \"string\",\n \"version\": \"string\"\n },\n \"bomExplosionDependent\": \"string\",\n \"createdDateTime\": \"2024-01-01T00:00:00Z\",\n \"customValues\": [\n {\n \"attribute\": {},\n \"value\": {}\n }\n ],\n \"description\": \"string\",\n \"descriptions\": [\n {\n \"description\": {},\n \"locale\": {}\n }\n ],\n \"isAutocompleteAndConfirmed\": true,\n \"isCurrentVersion\": true,\n \"locations\": [\n {\n \"description\": {},\n \"location\": {},\n \"locationData\": {}\n }\n ],\n \"lotSize\": 0.0,\n \"material\": \"string\",\n \"materialGroups\": [\n \"string\"\n ],\n \"materialType\": \"string\",\n \"maxShelfLife\": 0.0,\n \"maxShelfLifeUnits\": \"string\",\n \"modifiedDateTime\": \"2024-01-01T00:00:00Z\",\n \"mrpController\": \"string\",\n \"orderProcessingMode\": \"string\",\n \"origin\": \"string\",\n \"panel\": true,\n \"plant\": \"string\",\n \"procurementType\": \"string\",\n \"productionStorageLocation\": \"string\",\n \"putawayStorageLocation\": \"string\",\n \"quantityRestriction\": \"string\",\n \"removalComponentDataType\": {\n \"category\": \"string\",\n \"dataFieldList\": [\n {}\n ],\n \"dataType\": \"string\",\n \"description\": \"string\"\n },\n \"routing\": {\n \"plant\": \"string\",\n \"routing\": \"string\",\n \"routingType\": \"string\",\n \"version\": \"string\"\n },\n \"serialNumberProfile\": \"string\",\n \"status\": \"string\",\n \"targetLotSize\": 0.0,\n \"unitOfMeasure\": \"string\",\n \"version\": \"string\"\n }\n]"
}
},
{
"_id": "req_07cd7272a3fa45598d36d7b6",
"_type": "request",
"name": "Delete material.",
"description": "Deletes a material by plant, name, and version. If the version is not defined, then it deletes the current material version.",
"method": "DELETE",
"url": "{{ _.base_url }}/v1/materials",
"parentId": "req_bdf05ac73e9c4adda8589889",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "material",
"value": "",
"description": "Material name",
"disabled": false
},
{
"name": "plant",
"value": "",
"description": "Plant for which the request is executed",
"disabled": false
},
{
"name": "version",
"value": "",
"description": "Material version",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_4ec0d5d9e4034a9da3e45d09",
"_type": "request",
"name": "Finds material file attachments.",
"description": "Finds material file attachments by plant, name, and version.",
"method": "GET",
"url": "{{ _.base_url }}/v1/materials/fileAttachments",
"parentId": "req_bdf05ac73e9c4adda8589889",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "Plant for which the request is executed",
"disabled": false
},
{
"name": "material",
"value": "",
"description": "Material name",
"disabled": false
},
{
"name": "version",
"value": "",
"description": "Version of the material.",
"disabled": false
}
],
"authentication": {}
},
{
"_id": "req_0f476b061cc2456bbe9321d8",
"_type": "request",
"name": "Finds materials by plant; or by plant and material; or by plant, material, and version.",
"description": "Searches materials by plant; or by plant and material; or by plant, material, and version.",
"method": "GET",
"url": "{{ _.base_url }}/v2/materials",
"parentId": "req_bdf05ac73e9c4adda8589889",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "A plant for which the request is executed",
"disabled": false
},
{
"name": "material",
"value": "",
"description": "A material name",
"disabled": true
},
{
"name": "version",
"value": "",
"description": "A version of the material. If not present, all versions of the given material are returned.",
"disabled": true
},
{
"name": "page",
"value": "",
"description": "Page",
"disabled": true
},
{
"name": "size",
"value": "",
"description": "Size",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_d145c83f638b4524b81cc679",
"_type": "request",
"name": "Finds material header details by plant, name, and version.",
"description": "Searches for material header details by plant, name, and version.",
"method": "GET",
"url": "{{ _.base_url }}/v1/materials/headerDetails",
"parentId": "req_bdf05ac73e9c4adda8589889",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "material",
"value": "",
"description": "The material name",
"disabled": false
},
{
"name": "plant",
"value": "",
"description": "The plant for which the request is executed",
"disabled": false
},
{
"name": "version",
"value": "",
"description": "The version of the material. If not present, the header details for the current version of the material are returned.",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_d42c2401c8ff4bf7849cef66",
"_type": "request",
"name": "Upload a file.",
"description": "This API allows users to upload a file. The external URL of the uploaded file can be used during the creation of material attachments.",
"method": "POST",
"url": "{{ _.base_url }}/v1/file/upload",
"parentId": "req_bdf05ac73e9c4adda8589889",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {}
},
{
"_id": "req_d46a3c7d1c1e4fe69b9a02f1",
"_type": "request",
"name": "Download a file.",
"description": "This API allows users to download file content by using the provided external URL.",
"method": "GET",
"url": "{{ _.base_url }}/v1/file/download",
"parentId": "req_bdf05ac73e9c4adda8589889",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "externalFileUrl",
"value": "",
"description": "The external URL of the file you would like to download.",
"disabled": false
}
],
"authentication": {}
},
{
"_id": "req_f40501d8398b4b9180ae6ea5",
"_type": "request",
"name": "View contents of a file.",
"description": "This API allows users to preview file content by using the provided external URL.",
"method": "GET",
"url": "{{ _.base_url }}/v1/file/preview",
"parentId": "req_bdf05ac73e9c4adda8589889",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "externalFileUrl",
"value": "",
"description": "The external URL of the file that is to be downloaded.",
"disabled": false
}
],
"authentication": {}
},
{
"_id": "req_5a3abba1ee704a06956b806e",
"_type": "request_group",
"name": "Material Group",
"description": "Browse and modify material groups",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_d3e31c805f8a40ada0b60cab",
"_type": "request",
"name": "Find material group.",
"description": "Finds a material group by plant and name.",
"method": "GET",
"url": "{{ _.base_url }}/materialGroups",
"parentId": "req_5a3abba1ee704a06956b806e",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "The plant for which the request is executed",
"disabled": false
},
{
"name": "materialGroup",
"value": "",
"description": "Material group name",
"disabled": false
}
],
"authentication": {}
},
{
"_id": "req_cc43f03bdc6b40cba2b215ef",
"_type": "request",
"name": "Create material group.",
"description": "Creates a list of material groups for the given plant.",
"method": "POST",
"url": "{{ _.base_url }}/materialGroups",
"parentId": "req_5a3abba1ee704a06956b806e",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "[\n {\n \"materialGroup\": \"string\",\n \"plant\": \"string\"\n }\n]"
}
},
{
"_id": "req_424f845ea83d4fe3986f675e",
"_type": "request",
"name": "Update material group.",
"description": "Updates a list of material groups. Every material group that will be updated must have the material group and plant fields specified. Only the specified fields will be updated. Any unspecified fields will remain unchanged.",
"method": "PATCH",
"url": "{{ _.base_url }}/materialGroups",
"parentId": "req_5a3abba1ee704a06956b806e",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "[\n {\n \"materialGroup\": \"string\",\n \"plant\": \"string\"\n }\n]"
}
},
{
"_id": "req_8212f2262ac44f8b9cabde35",
"_type": "request",
"name": "Delete material group",
"description": "Deletes a material group by plant and name.",
"method": "DELETE",
"url": "{{ _.base_url }}/materialGroups",
"parentId": "req_5a3abba1ee704a06956b806e",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "The plant for which the request is executed",
"disabled": false
},
{
"name": "materialGroup",
"value": "",
"description": "Material group name",
"disabled": false
}
],
"authentication": {}
},
{
"_id": "req_5204d12b11704451839b0c1e",
"_type": "request_group",
"name": "Nonconformance",
"description": "Manage nonconformances as part of quality checks",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_ab3d031aff0944338ccc1549",
"_type": "request",
"name": "Logs a nonconformance.",
"description": "Logs a nonconformance for SFCs at a given operation for a given plant.",
"method": "POST",
"url": "{{ _.base_url }}/v1/log",
"parentId": "req_5204d12b11704451839b0c1e",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"code\": \"string\",\n \"plant\": \"string\",\n \"sfcs\": [\n \"string\"\n ]\n}"
}
},
{
"_id": "req_244c151f9b144c058e07f45c",
"_type": "request",
"name": "Check for open nonconformances",
"description": "Check for open nonconformance by the given SFCs.",
"method": "POST",
"url": "{{ _.base_url }}/v1/checkForOpen",
"parentId": "req_5204d12b11704451839b0c1e",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"bomLevel\": 0,\n \"plant\": \"string\",\n \"sfcs\": [\n \"string\"\n ]\n}"
}
},
{
"_id": "req_dc3018ff22a345408155796b",
"_type": "request",
"name": "Closes a nonconformance.",
"description": "Closes a nonconformance by the given incident ID.",
"method": "POST",
"url": "{{ _.base_url }}/v1/close",
"parentId": "req_5204d12b11704451839b0c1e",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"id\": \"string\",\n \"plant\": \"string\"\n}"
}
},
{
"_id": "req_625db6248264496b9eb6fce7",
"_type": "request",
"name": "Opens a nonconformance.",
"description": "Opens a nonconformance by the incident ID.",
"method": "POST",
"url": "{{ _.base_url }}/v1/open",
"parentId": "req_5204d12b11704451839b0c1e",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"id\": \"string\",\n \"plant\": \"string\"\n}"
}
},
{
"_id": "req_6418c00ee8a84201885e16e3",
"_type": "request",
"name": "Retrieves a non-conformance list.",
"description": "Retrieves a nonconformance list for a given plant by various optional parameters.",
"method": "GET",
"url": "{{ _.base_url }}/v1/nonconformances",
"parentId": "req_5204d12b11704451839b0c1e",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "operationActivity",
"value": "",
"description": "The operation activity with the current version to search for nonconformances.",
"disabled": true
},
{
"name": "plant",
"value": "",
"description": "The plant to search for nonconformances.",
"disabled": false
},
{
"name": "resource",
"value": "",
"description": "The resource to search for nonconformances.",
"disabled": true
},
{
"name": "routing",
"value": "",
"description": "The routing with the current version to search for nonconformances.",
"disabled": true
},
{
"name": "routingStepId",
"value": "",
"description": "The routing step to search for nonconformances.",
"disabled": true
},
{
"name": "sfc",
"value": "",
"description": "The SFC to search for nonconformances.",
"disabled": true
},
{
"name": "fromDate",
"value": "",
"description": "The date and time to only show nonconformances logged after or at the given time stamp in UTC.",
"disabled": true
},
{
"name": "toDate",
"value": "",
"description": "The date and time to only show nonconformances logged before or at the given time stamp in UTC.",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_46fb5d1a1d29418980ecd6b0",
"_type": "request",
"name": "Retrieves a list of nonconformance hierarchies.",
"description": "Retrieves a list of nonconformance hierarchies by plant and SFC.",
"method": "GET",
"url": "{{ _.base_url }}/v1/hierarchies",
"parentId": "req_5204d12b11704451839b0c1e",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "The plant to search for nonconformance hierarchies.",
"disabled": false
},
{
"name": "sfc",
"value": "",
"description": "The SFC to search for nonconformance hierarchies.",
"disabled": false
}
],
"authentication": {}
},
{
"_id": "req_59bb6c824d8a412886813aac",
"_type": "request",
"name": "Route nonconformant SFCs based on disposition settings.",
"description": "Performs the disposition of nonconformant SFCs at a given resource. A nonconformance incident has a nonconformance code with associated disposition routings. If there are several options for the disposition like several disposition routings in the NC code, a service returns DispositionOption objects for the selection. To select an option for the disposition of the SFC this API must be called again with the selected options. Note that you can use the ReturnStepId field only with the RETURN_TO_ANY and RETURN_TO_ANY_PREVIOUS disposition options. These options allow you to select a specific routing step.",
"method": "POST",
"url": "{{ _.base_url }}/v1/sfcs/disposition",
"parentId": "req_5204d12b11704451839b0c1e",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"dateTime\": \"string\",\n \"plant\": \"string\",\n \"sfcs\": [\n \"string\"\n ]\n}"
}
},
{
"_id": "req_38556171cb2040468d73c25e",
"_type": "request",
"name": "Downloads a nonconformance file.",
"description": "Downloads a nonconformance file for the given file ID",
"method": "GET",
"url": "{{ _.base_url }}/v1/file/download",
"parentId": "req_5204d12b11704451839b0c1e",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "fileId",
"value": "",
"description": "The ID of the file to download",
"disabled": false
}
],
"authentication": {}
},
{
"_id": "req_c74b8460c1d545128f8f2f36",
"_type": "request",
"name": "Retrieves a list of nonconformances.",
"description": "Retrieves a list of nonconformances for a given plant by various optional parameters.",
"method": "GET",
"url": "{{ _.base_url }}/v2/nonconformances",
"parentId": "req_5204d12b11704451839b0c1e",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "operationActivity",
"value": "",
"description": "The operation activity with the current version to search for nonconformances.",
"disabled": true
},
{
"name": "plant",
"value": "",
"description": "The plant to search for nonconformances.",
"disabled": false
},
{
"name": "resource",
"value": "",
"description": "The resource to search for nonconformances.",
"disabled": true
},
{
"name": "id",
"value": "",
"description": "The ID of the nonconformance incident.",
"disabled": true
},
{
"name": "routing",
"value": "",
"description": "The routing with the current version to search for nonconformances.",
"disabled": true
},
{
"name": "routingStepId",
"value": "",
"description": "The routing step to search for nonconformances.",
"disabled": true
},
{
"name": "sfc",
"value": "",
"description": "The SFC to search for nonconformances.",
"disabled": true
},
{
"name": "fromDate",
"value": "",
"description": "The date and time to only show nonconformances logged after or at the given time stamp in UTC.",
"disabled": true
},
{
"name": "toDate",
"value": "",
"description": "The date and time to only show nonconformances logged before or at the given time stamp in UTC.",
"disabled": true
},
{
"name": "page",
"value": "",
"description": "The page of nonconformances. By default, the system returns the first page.",
"disabled": true
},
{
"name": "size",
"value": "",
"description": "The size of the nonconformance page. By default, the page size is 20 records. The maximum page size is 1000.)",
"disabled": true
},
{
"name": "sort",
"value": "",
"description": "The retrieved records can be sorted using one or more of the following fields: 'id', 'state', 'createdDateTime'. Example: 'https://xxx?xxxx&sort=id,desc&sort=createdDateTime,desc' (By default the result sorted by logged date) ",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_50f575c4a685403abed0b01d",
"_type": "request_group",
"name": "Nonconformance Code",
"description": "Manage nonconformance codes",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_3a2f7d566e974d63a57bc217",
"_type": "request",
"name": "Read nonconformance code",
"description": "Reads a nonconformance code for a given plant and returns the details for the same",
"method": "GET",
"url": "{{ _.base_url }}/nonconformancecodes",
"parentId": "req_50f575c4a685403abed0b01d",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "code",
"value": "",
"description": "The nonconformance code value.",
"disabled": true
},
{
"name": "plant",
"value": "",
"description": "The plant where a nonconformance code is defined.",
"disabled": false
}
],
"authentication": {}
},
{
"_id": "req_5c5bdf437b2a4fc9b805f16e",
"_type": "request",
"name": "Create nonconformance code.",
"description": "Creates a nonconformance code for a given plant",
"method": "POST",
"url": "{{ _.base_url }}/nonconformancecodes",
"parentId": "req_50f575c4a685403abed0b01d",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"code\": \"string\",\n \"plant\": \"string\"\n}"
}
},
{
"_id": "req_f16ec447a0d24a43a654bf18",
"_type": "request",
"name": "Update nonconformance code.",
"description": "Updates a nonconformance code for a given plant",
"method": "PATCH",
"url": "{{ _.base_url }}/nonconformancecodes",
"parentId": "req_50f575c4a685403abed0b01d",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"code\": \"string\",\n \"plant\": \"string\"\n}"
}
},
{
"_id": "req_dbb946267c6440e79ac50196",
"_type": "request",
"name": "Delete nonconformance code.",
"description": "Deletes a nonconformance code for a given plant",
"method": "DELETE",
"url": "{{ _.base_url }}/nonconformancecodes",
"parentId": "req_50f575c4a685403abed0b01d",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {}
},
{
"_id": "req_245d4d8883c0473aaf75e801",
"_type": "request",
"name": "Retrieves a list of custom data definitions for nonconformance codes.",
"description": "Returns all maintained custom field definitions, for a given plant.",
"method": "GET",
"url": "{{ _.base_url }}/customFieldDefinitions",
"parentId": "req_50f575c4a685403abed0b01d",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "The plant where a custom field definitions are defined.",
"disabled": false
}
],
"authentication": {}
},
{
"_id": "req_d0e15d417c5f4dfa95b67412",
"_type": "request",
"name": "Creates a custom data definition for the nonconformance code.",
"description": "Creates a custom data definition for the nonconformance code.",
"method": "POST",
"url": "{{ _.base_url }}/customFieldDefinitions",
"parentId": "req_50f575c4a685403abed0b01d",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"fieldName\": \"string\",\n \"plant\": \"string\"\n}"
}
},
{
"_id": "req_8c9dd73ad6f74051b67b6291",
"_type": "request",
"name": "Updates a custom data definition for the nonconformance code.",
"description": "Updates field label or sequence in the custom field definition for the nonconformance code.",
"method": "PATCH",
"url": "{{ _.base_url }}/customFieldDefinitions",
"parentId": "req_50f575c4a685403abed0b01d",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"fieldName\": \"string\",\n \"modifiedDateTime\": \"2024-01-01T00:00:00Z\",\n \"plant\": \"string\"\n}"
}
},
{
"_id": "req_9cb57c3162254bbab12a9ff0",
"_type": "request",
"name": "Deletes a custom data definition for the nonconformance code.",
"description": "Deletes a custom data definition for the nonconformance code.",
"method": "DELETE",
"url": "{{ _.base_url }}/customFieldDefinitions",
"parentId": "req_50f575c4a685403abed0b01d",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {}
},
{
"_id": "req_b3f156319e524ef992ad5b34",
"_type": "request_group",
"name": "Nonconformance Group",
"description": "Browse and modify nonconformance groups",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_a3d1774972a348c197f88a2d",
"_type": "request",
"name": "Read nonconformance group",
"description": "Reads nonconformance groups by plant and group",
"method": "GET",
"url": "{{ _.base_url }}/nonconformancegroups",
"parentId": "req_b3f156319e524ef992ad5b34",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "group",
"value": "",
"description": "The nonconformance group value.",
"disabled": true
},
{
"name": "plant",
"value": "",
"description": "The plant where a nonconformance group is defined.",
"disabled": false
}
],
"authentication": {}
},
{
"_id": "req_108a5c6be04d41ca87330821",
"_type": "request",
"name": "Create nonconformance group.",
"description": "Creates a nonconformance group for a given plant",
"method": "POST",
"url": "{{ _.base_url }}/nonconformancegroups",
"parentId": "req_b3f156319e524ef992ad5b34",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"group\": \"string\",\n \"plant\": \"string\"\n}"
}
},
{
"_id": "req_93db132feb0049beabfcffaf",
"_type": "request",
"name": "Update nonconformance group.",
"description": "Updates a nonconformance group for a given plant",
"method": "PATCH",
"url": "{{ _.base_url }}/nonconformancegroups",
"parentId": "req_b3f156319e524ef992ad5b34",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"group\": \"string\",\n \"plant\": \"string\"\n}"
}
},
{
"_id": "req_ef217fe956cd43ca9c4a5690",
"_type": "request",
"name": "Delete nonconformance group.",
"description": "Deletes a nonconformance group for a given plant",
"method": "DELETE",
"url": "{{ _.base_url }}/nonconformancegroups",
"parentId": "req_b3f156319e524ef992ad5b34",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {}
},
{
"_id": "req_041150f7f1bb4648adb6849b",
"_type": "request_group",
"name": "Operation Activity",
"description": "Operation activities associated with a routing.",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_23654499e9f444d6ac1a5e2c",
"_type": "request",
"name": "Finds list of operation activities.",
"description": "Finds a list operation activities by plant and other optional criteria.",
"method": "GET",
"url": "{{ _.base_url }}/operationActivities",
"parentId": "req_041150f7f1bb4648adb6849b",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "plant",
"disabled": false
},
{
"name": "operation",
"value": "",
"description": "operation",
"disabled": true
},
{
"name": "version",
"value": "",
"description": "version",
"disabled": true
},
{
"name": "type",
"value": "",
"description": "type",
"disabled": true
},
{
"name": "currentVersion",
"value": "",
"description": "current version flag",
"disabled": true
},
{
"name": "resourceType",
"value": "",
"description": "resource type",
"disabled": true
},
{
"name": "status",
"value": "",
"description": "status",
"disabled": true
},
{
"name": "pageable",
"value": "",
"description": "Pagination parameters",
"disabled": false
}
],
"authentication": {}
},
{
"_id": "req_561c7e9e297e4885bcd6f3ca",
"_type": "request",
"name": "Creates a list of operation activities.",
"description": "Creates a list of operation activities with specified properties. In case operation type is not specified it is defaulted to NORMAL_OPERATION.",
"method": "POST",
"url": "{{ _.base_url }}/operationActivities",
"parentId": "req_041150f7f1bb4648adb6849b",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "[\n {\n \"operation\": \"string\",\n \"plant\": \"string\",\n \"resourceType\": {\n \"resourceType\": \"string\"\n },\n \"version\": \"string\"\n }\n]"
}
},
{
"_id": "req_14171e89196a49de9c310215",
"_type": "request",
"name": "Updates a list of operation activities.",
"description": "Every operation activity that will be updated must have the plant, operation, and version fields specified. Only the specified fields will be updated. Any unspecified fields will remain unchanged.",
"method": "PATCH",
"url": "{{ _.base_url }}/operationActivities",
"parentId": "req_041150f7f1bb4648adb6849b",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "[\n {\n \"currentVersion\": true,\n \"customValues\": [\n {\n \"attribute\": {}\n }\n ],\n \"description\": \"string\",\n \"operation\": \"string\",\n \"plant\": \"string\",\n \"requiredTimeInProcess\": 0,\n \"resource\": {\n \"resource\": \"string\"\n },\n \"resourceType\": {\n \"resourceType\": \"string\"\n },\n \"status\": \"string\",\n \"type\": \"string\",\n \"version\": \"string\",\n \"workCenter\": {\n \"workCenter\": \"string\"\n }\n }\n]"
}
},
{
"_id": "req_810a58be2294428a9326d01b",
"_type": "request",
"name": "Deletes an operation activity.",
"description": "Deletes an operation activity by plant, name, and version.",
"method": "DELETE",
"url": "{{ _.base_url }}/operationActivities",
"parentId": "req_041150f7f1bb4648adb6849b",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "plant",
"disabled": false
},
{
"name": "operation",
"value": "",
"description": "operation",
"disabled": false
},
{
"name": "version",
"value": "",
"description": "version",
"disabled": false
}
],
"authentication": {}
},
{
"_id": "req_a00172cba6f64a1cafc8724c",
"_type": "request_group",
"name": "Order",
"description": "Perform order related activities, such as getting order details and releasing the order for manufacturing",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_9bfe60f09be44169b8dd0848",
"_type": "request",
"name": "Finds a list of orders.",
"description": "Finds a list of orders for a given plant.",
"method": "GET",
"url": "{{ _.base_url }}/v2/plants/{plant}/orders",
"parentId": "req_a00172cba6f64a1cafc8724c",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "material",
"value": "",
"description": "Material associated with the order.",
"disabled": true
},
{
"name": "materialVersion",
"value": "",
"description": "Version of the material",
"disabled": true
},
{
"name": "releaseStatuses",
"value": "",
"description": "Release status",
"disabled": true
},
{
"name": "executionStatuses",
"value": "",
"description": "Execution status",
"disabled": true
},
{
"name": "workCenters",
"value": "",
"description": "Work center names",
"disabled": true
},
{
"name": "order",
"value": "",
"description": "The order to search for.",
"disabled": true
},
{
"name": "salesOrder",
"value": "",
"description": "Sales order",
"disabled": true
},
{
"name": "customer",
"value": "",
"description": "Customer",
"disabled": true
},
{
"name": "plannedStart",
"value": "",
"description": "Planned start date in UTC format (date-time). Orders with planned start equal to or later than this value are included.",
"disabled": true
},
{
"name": "plannedEnd",
"value": "",
"description": "Planned completion date in UTC format (date-time). Orders with planned end equal to or earlier than this value are included.",
"disabled": true
},
{
"name": "scheduledStart",
"value": "",
"description": "Scheduled start date in UTC format (date-time). Orders with scheduled start equal to or later than this value are included.",
"disabled": true
},
{
"name": "scheduledEnd",
"value": "",
"description": "Scheduled completion date in UTC format (date-time). Orders with scheduled end equal to or earlier than this value are included.",
"disabled": true
},
{
"name": "page",
"value": "",
"description": "The current page index (starts from 0). Default index is 0.",
"disabled": true
},
{
"name": "size",
"value": "",
"description": "Specify the page size that determines how many orders display on a single page. It's 20 by default.",
"disabled": true
},
{
"name": "sort",
"value": "",
"description": "Sorting criteria in the format: property,asc/desc. The supported properties for sorting are: order, plant, plannedStart/End, scheduledStart/End, actualStart/End, plannedQuantity, buildQuantity, releasedQuantity, deliveredQuantity, priority, salesOrder.",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_1c8de4d5f9444912a5bc1296",
"_type": "request",
"name": "Releases the order.",
"description": "Releases the order by given plant, order, and quantity for further manufacturing activities.",
"method": "POST",
"url": "{{ _.base_url }}/v2/orders/release",
"parentId": "req_a00172cba6f64a1cafc8724c",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"order\": \"string\",\n \"plant\": \"string\"\n}"
}
},
{
"_id": "req_9d3addb4c7fb49109d75a02d",
"_type": "request_group",
"name": "Order",
"description": "Perform order related activities, such as getting order details and releasing the order for manufacturing",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_ff576f57dbd448499bb742f4",
"_type": "request",
"name": "Finds order data by plant and order.",
"description": "Finds the detailed data like order header, SFC list, associated custom data for the given plant and order.",
"method": "GET",
"url": "{{ _.base_url }}/v1/orders",
"parentId": "req_9d3addb4c7fb49109d75a02d",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
},
{
"name": "Accept-Language",
"value": "",
"description": "The Accept-Language request HTTP header indicates the natural language and locale that the client prefers."
}
],
"parameters": [
{
"name": "expand",
"value": "",
"description": "Option to use a comma-separated list of properties to expand. Current supported option is 'schedules'.",
"disabled": true
},
{
"name": "order",
"value": "",
"description": "The order to be found",
"disabled": false
},
{
"name": "ignoreSfcs",
"value": "",
"description": "Set it to 'true' if you don't need the SFCs in the payload.",
"disabled": true
},
{
"name": "plant",
"value": "",
"description": "Plant for which the request is executed",
"disabled": false
},
{
"name": "language",
"value": "",
"description": "The specified language of the header text.",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_291c872892a246a0a98fa19b",
"_type": "request",
"name": "Creates an order with provided data",
"description": "Creates a production order with the provided data and returns details of the created order.",
"method": "POST",
"url": "{{ _.base_url }}/v1/orders",
"parentId": "req_9d3addb4c7fb49109d75a02d",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"bom\": {\n \"bom\": \"string\"\n },\n \"material\": \"string\",\n \"orderCategory\": \"string\",\n \"orderNumber\": \"string\",\n \"plannedEnd\": \"2024-01-01T00:00:00Z\",\n \"plannedQuantityInBaseUnit\": 0.0,\n \"plannedStart\": \"2024-01-01T00:00:00Z\",\n \"plant\": \"string\",\n \"routing\": {\n \"entryRoutingStepId\": \"string\",\n \"routing\": \"string\",\n \"routingOperationGroups\": [\n {\n \"operationNumber\": {},\n \"routingOperationGroup\": {},\n \"routingStepIds\": {}\n }\n ],\n \"routingSteps\": [\n {\n \"erpSequence\": {},\n \"stepId\": {},\n \"workCenter\": {}\n }\n ],\n \"routingType\": \"string\"\n }\n}"
}
},
{
"_id": "req_95e06a7915214f7a8ee78d4a",
"_type": "request",
"name": "Finds list of orders.",
"description": "Finds a list of orders for a given plant.",
"method": "GET",
"url": "{{ _.base_url }}/v1/orders/list",
"parentId": "req_9d3addb4c7fb49109d75a02d",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "Plant for which the request is executed.",
"disabled": false
},
{
"name": "material",
"value": "",
"description": "Material associated with the order.",
"disabled": true
},
{
"name": "materialVersion",
"value": "",
"description": "Version of the material",
"disabled": true
},
{
"name": "releaseStatuses",
"value": "",
"description": "Release status",
"disabled": true
},
{
"name": "executionStatuses",
"value": "",
"description": "Execution status",
"disabled": true
},
{
"name": "workCenters",
"value": "",
"description": "Work center names",
"disabled": true
},
{
"name": "order",
"value": "",
"description": "The order to be searched.",
"disabled": true
},
{
"name": "customerOrder",
"value": "",
"description": "Customer order",
"disabled": true
},
{
"name": "customer",
"value": "",
"description": "Customer",
"disabled": true
},
{
"name": "plannedStartDate",
"value": "",
"description": "Planned start date in UTC format (date-time)",
"disabled": true
},
{
"name": "plannedCompletionDate",
"value": "",
"description": "Planned completion date in UTC format (date-time)",
"disabled": true
},
{
"name": "scheduledStartDate",
"value": "",
"description": "Scheduled start date in UTC format (date-time)",
"disabled": true
},
{
"name": "scheduledCompletionDate",
"value": "",
"description": "Scheduled completion date in UTC format (date-time)",
"disabled": true
},
{
"name": "page",
"value": "",
"description": "Page",
"disabled": true
},
{
"name": "size",
"value": "",
"description": "Size",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_0b934eca4694465481d06bf1",
"_type": "request",
"name": "Releases the given order.",
"description": "Releases the order by given plant, order and quantity for further manufacturing activities. This endpoint is being deprecated and please use successor /v2/orders/release",
"method": "POST",
"url": "{{ _.base_url }}/v1/orders/release",
"parentId": "req_9d3addb4c7fb49109d75a02d",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"order\": \"string\",\n \"plant\": \"string\"\n}"
}
},
{
"_id": "req_ad5b4dd1805c4d849601909e",
"_type": "request",
"name": "Releases order in background for the given order.",
"description": "Releases the order in background by given plant, order and quantity for further manufacturing activities.",
"method": "POST",
"url": "{{ _.base_url }}/v1/orders/releaseInBackground",
"parentId": "req_9d3addb4c7fb49109d75a02d",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"order\": \"string\",\n \"plant\": \"string\"\n}"
}
},
{
"_id": "req_08513340bec84df49182fcff",
"_type": "request",
"name": "Complete order",
"description": "Complete the order for a given plant",
"method": "POST",
"url": "{{ _.base_url }}/v1/orders/complete",
"parentId": "req_9d3addb4c7fb49109d75a02d",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "order",
"value": "",
"description": "The shop order number",
"disabled": false
},
{
"name": "plant",
"value": "",
"description": "The plant",
"disabled": false
}
],
"authentication": {}
},
{
"_id": "req_14a727ad5d2a4fc5aa2e4fcb",
"_type": "request",
"name": "Discard order",
"description": "Discard the order for a given plant",
"method": "POST",
"url": "{{ _.base_url }}/v1/orders/discard",
"parentId": "req_9d3addb4c7fb49109d75a02d",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "order",
"value": "",
"description": "The shop order number",
"disabled": false
},
{
"name": "plant",
"value": "",
"description": "The plant",
"disabled": false
}
],
"authentication": {}
},
{
"_id": "req_be00c69592da45f1bcda3a89",
"_type": "request",
"name": "Updates custom values",
"description": "Updates custom values for the given order",
"method": "PATCH",
"url": "{{ _.base_url }}/v1/orders/customValues",
"parentId": "req_9d3addb4c7fb49109d75a02d",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"customValues\": [\n {\n \"attribute\": \"string\",\n \"value\": \"string\"\n }\n ],\n \"order\": \"string\",\n \"plant\": \"string\"\n}"
}
},
{
"_id": "req_a844e23e110842dd9e528fbc",
"_type": "request",
"name": "Retrieves a list of custom data definitions for the order.",
"description": "Retrieves a list of custom data definitions for the order by plant.",
"method": "GET",
"url": "{{ _.base_url }}/v1/orders/customFieldDefinitions",
"parentId": "req_9d3addb4c7fb49109d75a02d",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "The plant where custom field definitions are defined.",
"disabled": false
},
{
"name": "page",
"value": "",
"description": "The current page number(starting from 0).",
"disabled": true
},
{
"name": "size",
"value": "",
"description": "The maximum number of items displayed per page.",
"disabled": true
},
{
"name": "sort",
"value": "",
"description": "The field of the response entity to sort by.",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_fedd114555c54319a07091b1",
"_type": "request",
"name": "Creates custom data definitions for the order.",
"description": "Creates custom data definitions for the order. The maximum number of custom field definitions in one request is 500. The maximum number of custom field definitions in each plant is 2000.",
"method": "POST",
"url": "{{ _.base_url }}/v1/orders/customFieldDefinitions",
"parentId": "req_9d3addb4c7fb49109d75a02d",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"definitions\": [\n {\n \"fieldName\": \"string\"\n }\n ],\n \"plant\": \"string\"\n}"
}
},
{
"_id": "req_01adf9bb2897401a83b8b70c",
"_type": "request",
"name": "Updates custom data definitions for the order.",
"description": "Updates custom data definitions for the order. The maximum number of custom field definitions in one request is 500. ",
"method": "PATCH",
"url": "{{ _.base_url }}/v1/orders/customFieldDefinitions",
"parentId": "req_9d3addb4c7fb49109d75a02d",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"definitions\": [\n {\n \"fieldName\": \"string\"\n }\n ],\n \"plant\": \"string\"\n}"
}
},
{
"_id": "req_6b4b3c080ea349cc943e3dcc",
"_type": "request",
"name": "Deletes custom data definitions for the order.",
"description": "Deletes custom data definitions for the order by definition names.",
"method": "DELETE",
"url": "{{ _.base_url }}/v1/orders/customFieldDefinitions",
"parentId": "req_9d3addb4c7fb49109d75a02d",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {}
},
{
"_id": "req_3617431778b549dfb9868d43",
"_type": "request_group",
"name": "Order Schedules",
"description": "Retrieve and schedule the order schedules of a plant for a specific date range",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_47788ab5cbb344e5aabadab8",
"_type": "request",
"name": "Provides the shop order schedules of a plant for a given date range.",
"description": "Retrieve all operations scheduled on a shop floor for a date range.",
"method": "POST",
"url": "{{ _.base_url }}/shoporderschedules",
"parentId": "req_3617431778b549dfb9868d43",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"endDateTime\": \"string\",\n \"plant\": \"string\",\n \"startDateTime\": \"string\",\n \"user\": \"string\"\n}"
}
},
{
"_id": "req_03725e045e4f46b0977c1ab4",
"_type": "request",
"name": "Schedule an order to a specific resource and work center within a given range.",
"description": "Retrieves all operations for a given order and schedules it to the corresponding resource and work center on the shop floor for a specified date range, according to the selected scheduling mode; if none is specified, scheduling defaults to Infinite mode.",
"method": "POST",
"url": "{{ _.base_url }}/scheduleOrders",
"parentId": "req_3617431778b549dfb9868d43",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"endDateTime\": \"string\",\n \"plant\": \"string\",\n \"shopOrder\": \"string\",\n \"startDateTime\": \"string\",\n \"user\": \"string\"\n}"
}
},
{
"_id": "req_0f0e32e343fd4357bba09436",
"_type": "request",
"name": "Reschedule an order to a specific resource for a given date.",
"description": "Retrieves all operations for a given order and schedules it to their respective resource for the specified date, according to the selected scheduling mode; if none is specified, scheduling defaults to Infinite mode.",
"method": "POST",
"url": "{{ _.base_url }}/rescheduleOrder",
"parentId": "req_3617431778b549dfb9868d43",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "singleOperation",
"value": "",
"description": "Reschedule for single operation.",
"disabled": true
}
],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"order\": \"string\",\n \"plant\": \"string\"\n}"
}
},
{
"_id": "req_491f2d39449143c8bfdee067",
"_type": "request_group",
"name": "Overall Equipment Effectiveness",
"description": "Obtain data from SAP Digital Manufacturing for insights",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_80555d31bbca4dd88ac56e9d",
"_type": "request",
"name": "Provides all the Availability downtime losses for the associated filter condition",
"description": "You can retrieve all the availability downtime losses for the given input parameters. The difference between startDateTime and endDateTime cannot be greater than 7 days.
The startDateTime and endDateTime cannot be at a later point in time.
A maximum of 5 Resources can be provided at a time.
Note: You can provide either parent resource or child resource. If you provide parent resource, data is retrieved based on the parent resource availability calculation described [here](https://help.sap.com/docs/sap-digital-manufacturing/insights/parent-resource-availability-calculation?state=DRAFT).
All those shifts whose start time lies within the startDateTime and endDateTime are considered for calculation.",
"method": "GET",
"url": "{{ _.base_url }}/v1/availabilityLosses",
"parentId": "req_491f2d39449143c8bfdee067",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "The plant for which the Availability Downtime losses are required.",
"disabled": false
},
{
"name": "resources",
"value": "",
"description": "The list of the resources for which the Availability Downtime losses are required.",
"disabled": false
},
{
"name": "startDateTime",
"value": "",
"description": "The starting date for the time window in YYYY-MM-DDThh:mm:ssZ format.",
"disabled": false
},
{
"name": "endDateTime",
"value": "",
"description": "The ending date for the time window in YYYY-MM-DDThh:mm:ssZ format.",
"disabled": false
},
{
"name": "timeElementType",
"value": "",
"description": "The TimeElementType for which the Availability Downtime losses are required.",
"disabled": false
},
{
"name": "timeElements",
"value": "",
"description": "The list of the timeElement for which the Availability Downtime losses are required.",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_86d29b8f36b44951b54620f1",
"_type": "request",
"name": "Provides the production summary for the associated filter condition",
"description": "You can retrieve production summary for the given input parameters.
The difference between startDateTime and endDateTime cannot be greater than 7 days.
The startDateTime and endDateTime cannot be at a later point in time.
A maximum of 5 Resources can be provided at a time.
Note: Only parent resource is supported.
All those shifts whose start time lies within the startDateTime and endDateTime are considered for calculation. ",
"method": "GET",
"url": "{{ _.base_url }}/v1/productionSummary",
"parentId": "req_491f2d39449143c8bfdee067",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "The plant for which the summary is required.",
"disabled": false
},
{
"name": "resources",
"value": "",
"description": "The list of the resources for which the summary is required.",
"disabled": false
},
{
"name": "startDateTime",
"value": "",
"description": "The starting date for the time window in YYYY-MM-DDThh:mm:ssZ format.",
"disabled": false
},
{
"name": "endDateTime",
"value": "",
"description": "The ending date for the time window in YYYY-MM-DDThh:mm:ssZ format.",
"disabled": false
}
],
"authentication": {}
},
{
"_id": "req_2bbd2933162b46c19f344d74",
"_type": "request",
"name": "Provides the time element duration by time element type for the associated filter condition",
"description": "You can retrieve all the time element durations for the given input parameters.
The difference between startDateTime and endDateTime cannot be greater than 7 days.
The startDateTime and endDateTime cannot be at a later point in time.
A maximum of 5 Resources can be provided at a time.
Note: Only parent resource is supported.
All those shifts whose start time lies within the startDateTime and endDateTime are considered for calculation.",
"method": "GET",
"url": "{{ _.base_url }}/v1/timeElementsByTimeElementType",
"parentId": "req_491f2d39449143c8bfdee067",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "The plant for which the time buckets are required.",
"disabled": false
},
{
"name": "resources",
"value": "",
"description": "The list of resources for which the time buckets are required.",
"disabled": false
},
{
"name": "startDateTime",
"value": "",
"description": "The starting date for the time window in YYYY-MM-DDThh:mm:ssZ format.",
"disabled": false
},
{
"name": "endDateTime",
"value": "",
"description": "The ending date for the time window in YYYY-MM-DDThh:mm:ssZ format.",
"disabled": false
},
{
"name": "timeElementType",
"value": "",
"description": "The TimeElementType for which the time buckets are required.",
"disabled": false
}
],
"authentication": {}
},
{
"_id": "req_dba6f9a60b9e4ae488df5f3d",
"_type": "request",
"name": "Provides the performance losses for the associated filter condition",
"description": "You can retrieve all the performance losses for the given input parameters.
The difference between startDateTime and endDateTime cannot be greater than 7 days.
The startDateTime and endDateTime cannot be at a later point in time.
A maximum of 5 Resources can be provided at a time.
Note: Only parent resource is supported.
All those shifts whose start time lies within the startDateTime and endDateTime are considered for calculation.",
"method": "GET",
"url": "{{ _.base_url }}/v1/performanceLosses",
"parentId": "req_491f2d39449143c8bfdee067",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "The plant for which the Performance Losses are required.",
"disabled": false
},
{
"name": "resources",
"value": "",
"description": "The list of resources for which the Performance Losses are required.",
"disabled": false
},
{
"name": "startDateTime",
"value": "",
"description": "The starting date for the time window in YYYY-MM-DDThh:mm:ssZ format.",
"disabled": false
},
{
"name": "endDateTime",
"value": "",
"description": "The ending date for the time window in YYYY-MM-DDThh:mm:ssZ format.",
"disabled": false
},
{
"name": "timeElementType",
"value": "",
"description": "The TimeElementType for which the Performance Losses are required.",
"disabled": false
},
{
"name": "timeElements",
"value": "",
"description": "The list of the timeElement for which the performance losses are required.",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_b075ea2273044394b65d344a",
"_type": "request",
"name": "Provides all the Speed losses for the associated filter condition",
"description": "You can retrieve all the speed losses for the given input parameters. The difference between startDateTime and endDateTime cannot be greater than 7 days.
The startDateTime and endDateTime cannot be at a later point in time.All those shifts whose start time lies within the startDateTime and endDateTime are considered for calculation.
If no value is provided for the optional type query parameter then both tagged and untagged speed losses are retrieved.
Note: Only parent resource is supported.",
"method": "GET",
"url": "{{ _.base_url }}/v1/speedLosses",
"parentId": "req_491f2d39449143c8bfdee067",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "The plant for which the Speed losses are required.",
"disabled": false
},
{
"name": "resource",
"value": "",
"description": "The resource for which the Speed losses are required.",
"disabled": false
},
{
"name": "order",
"value": "",
"description": "The order for which the Speed losses are required.",
"disabled": false
},
{
"name": "operationActivity",
"value": "",
"description": "The operationActivity for which the Speed losses are required.",
"disabled": false
},
{
"name": "startDateTime",
"value": "",
"description": "The starting date for the time window in YYYY-MM-DDThh:mm:ssZ format.",
"disabled": false
},
{
"name": "endDateTime",
"value": "",
"description": "The ending date for the time window in YYYY-MM-DDThh:mm:ssZ format.",
"disabled": false
},
{
"name": "type",
"value": "",
"description": "The type of Speed loss which is required.",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_891b9627a4a743d1be25060f",
"_type": "request",
"name": "Provides the quality losses for the associated filter condition",
"description": "You can retrieve all the quality losses for the given input parameters.
The difference between startDateTime and endDateTime cannot be greater than 7 days.
The startDateTime and endDateTime cannot be at a later point in time.All those shifts whose start time lies within the startDateTime and endDateTime are considered for calculation.
A maximum of 5 Resources can be provided at a time.
Note: Only parent resource is supported.
A maximum of 5 Time Elements can be provided at a time.",
"method": "GET",
"url": "{{ _.base_url }}/v1/qualityLosses",
"parentId": "req_491f2d39449143c8bfdee067",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "The plant for which the quality losses are required.",
"disabled": false
},
{
"name": "resources",
"value": "",
"description": "The list of resources for which the quality losses are required.",
"disabled": false
},
{
"name": "startDateTime",
"value": "",
"description": "The starting date for the time window in YYYY-MM-DDThh:mm:ssZ format.",
"disabled": false
},
{
"name": "endDateTime",
"value": "",
"description": "The ending date for the time window in YYYY-MM-DDThh:mm:ssZ format.",
"disabled": false
},
{
"name": "timeElementType",
"value": "",
"description": "The TimeElementType for which the time buckets are required.",
"disabled": false
},
{
"name": "timeElements",
"value": "",
"description": "The list of the timeElement for which the quality losses are required.",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_40c71963cc9949678f7376b1",
"_type": "request_group",
"name": "Packing Unit",
"description": "Manage activities for packing units",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_02d746af3e0b40568efa108b",
"_type": "request",
"name": "Finds a packing unit by plant and number.",
"description": "This endpoint can be called to obtain a single packing unit. As a search parameters it uses plant and packing unit number.",
"method": "GET",
"url": "{{ _.base_url }}/packingUnits",
"parentId": "req_40c71963cc9949678f7376b1",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "number",
"value": "",
"description": "Packing Unit Number",
"disabled": false
},
{
"name": "plant",
"value": "",
"description": "Plant for which the request is executed",
"disabled": false
}
],
"authentication": {}
},
{
"_id": "req_a4abfbdff1884666b4137ff1",
"_type": "request",
"name": "Creates a packing unit.",
"description": "This endpoint can be called to create a new packing unit.",
"method": "POST",
"url": "{{ _.base_url }}/packingUnits",
"parentId": "req_40c71963cc9949678f7376b1",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"plant\": \"string\"\n}"
}
},
{
"_id": "req_6059e07aba0c41ffb242e611",
"_type": "request",
"name": "Updates a packing unit.",
"description": "This endpoint can be called to edit an existing packing unit.",
"method": "PUT",
"url": "{{ _.base_url }}/packingUnits",
"parentId": "req_40c71963cc9949678f7376b1",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"material\": {\n \"material\": \"string\",\n \"plant\": \"string\",\n \"version\": \"string\"\n },\n \"modifiedDateTime\": \"2024-01-01T00:00:00Z\",\n \"number\": \"string\",\n \"plant\": \"string\"\n}"
}
},
{
"_id": "req_064f3ab5af234df180e1ecfc",
"_type": "request",
"name": "Closes an Open Packing Unit.",
"description": "This endpoint can be called to change the status of the Packing Unit to Closed. The required parameters for this endpoint are plant and packing unit number.",
"method": "POST",
"url": "{{ _.base_url }}/packingUnits/pack",
"parentId": "req_40c71963cc9949678f7376b1",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"packingUnitNumber\": \"string\",\n \"plant\": \"string\"\n}"
}
},
{
"_id": "req_7622617a4f30432998032fe6",
"_type": "request",
"name": "Re-opens a Closed Packing Unit.",
"description": "This endpoint can be called to change the status of the Packing Unit to Opened. The required parameters are Plant and Packing Unit Number.",
"method": "POST",
"url": "{{ _.base_url }}/packingUnits/unpack",
"parentId": "req_40c71963cc9949678f7376b1",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"packingUnitNumber\": \"string\",\n \"plant\": \"string\"\n}"
}
},
{
"_id": "req_05696faab31d4a8aaa0d099e",
"_type": "request",
"name": "Adds content to a Packing Unit.",
"description": "This endpoint can be called to add content to the Packing Unit.",
"method": "POST",
"url": "{{ _.base_url }}/packingUnits/content",
"parentId": "req_40c71963cc9949678f7376b1",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "packingUnit",
"value": "",
"description": "The Packing Unit Number to which content items are added to",
"disabled": false
},
{
"name": "plant",
"value": "",
"description": "The plant of the packing unit",
"disabled": false
},
{
"name": "allowedSfcStatuses",
"value": "",
"description": "The list of statuses of SFCs (Shop Floor Controls) that can be packed. These statuses include NEW, IN_QUEUE, ACTIVE, DONE, HOLD.",
"disabled": true
},
{
"name": "allowMixedOperations",
"value": "",
"description": "Allows SFCs at different operations to be packed into the same packing unit.",
"disabled": true
},
{
"name": "allowMixedOrders",
"value": "",
"description": "Allows SFCs from different orders to be packed into the same packing unit.",
"disabled": true
},
{
"name": "allowAddConformantSfcToNonConformantPackingUnit",
"value": "",
"description": "Allows you to pack conformant SFCs to a nonconformant packing unit.",
"disabled": true
}
],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "[\n {\n \"packingUnitNumber\": \"string\",\n \"quantity\": 0.0,\n \"sfc\": \"string\"\n }\n]"
}
},
{
"_id": "req_25e6d4a209954cc9808775b8",
"_type": "request",
"name": "Removes content from a Packing Unit.",
"description": "This endpoint can be called to remove content from the Packing Unit. The required parameters are SFC, Packing Unit Number, and Quantity.",
"method": "DELETE",
"url": "{{ _.base_url }}/packingUnits/content",
"parentId": "req_40c71963cc9949678f7376b1",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "packingUnit",
"value": "",
"description": "The Packing Unit Number from which content items are removed from.",
"disabled": false
},
{
"name": "plant",
"value": "",
"description": "The plant of the packing unit",
"disabled": false
}
],
"authentication": {}
},
{
"_id": "req_4f3d5a1640b647939f18112f",
"_type": "request",
"name": "Updates the carrier of a packing unit.",
"description": "Updates an existing packing unit with a new carrier. You can call this API endpoint when the carrier of the packing unit is broken or unusable. All the items in the packing unit will be moved to the new carrier you specify here. ",
"method": "POST",
"url": "{{ _.base_url }}/changeCarrier",
"parentId": "req_40c71963cc9949678f7376b1",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"newCarrierNumber\": \"string\",\n \"oldCarrierNumber\": \"string\",\n \"plant\": \"string\"\n}"
}
},
{
"_id": "req_2bc32a43ec6b4f36b98fb6a9",
"_type": "request",
"name": "Unloads a packing unit.",
"description": "Unloads the whole packing unit, or unloads some of the items for a given packing unit.",
"method": "PUT",
"url": "{{ _.base_url }}/unloadPackingUnit",
"parentId": "req_40c71963cc9949678f7376b1",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"plant\": \"string\"\n}"
}
},
{
"_id": "req_881f8786302046a3ad9acc13",
"_type": "request",
"name": "Gets packing units for a given plant and carrier number.",
"description": "Retrieves packing units that are loaded on a specific carrier for a given plant. You can also retrieve orders and shop floor controls (SFCs) associated with the packing units.",
"method": "GET",
"url": "{{ _.base_url }}/carrier/packingUnit",
"parentId": "req_40c71963cc9949678f7376b1",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "carrierNumber",
"value": "",
"description": "The carrier number for which the request is executed",
"disabled": false
},
{
"name": "plant",
"value": "",
"description": "The plant for which the request is executed",
"disabled": false
}
],
"authentication": {}
},
{
"_id": "req_f037a7dfb2b7457aaa9e2de5",
"_type": "request_group",
"name": "Plant",
"description": "Get a list of plants.",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_40184e0de6804339ac4a2688",
"_type": "request",
"name": "Searches for plants.",
"description": "Finds all plants or or specific plant by name.",
"method": "GET",
"url": "{{ _.base_url }}/plants",
"parentId": "req_f037a7dfb2b7457aaa9e2de5",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "The plant name.",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_45aba9064fe0454d83327d16",
"_type": "request_group",
"name": "Print",
"description": "Document Print Template printing",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_aff6140e573647dcb9876c22",
"_type": "request",
"name": "Prints a document print template on a given printer.",
"description": "Creates a print task in the status of New. The print task is automatically started. A print task can be in one of the following statuses: New, Started, Failed, or Sent to Printer. You can find the created print task in the Reprint Documents app. A print task consists of sequential calls of data acquisition, document format, and transport plugins. The data acquisition and document format plugins are taken from the document print template. The transport plugin is taken from the printer. By default, a print task is asynchronously executed but it can be run synchronously till its status changes to Sent to Printer.",
"method": "POST",
"url": "{{ _.base_url }}/v1/print",
"parentId": "req_45aba9064fe0454d83327d16",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"document\": \"string\",\n \"printer\": \"string\"\n}"
}
},
{
"_id": "req_57a1f881260549c49d13cdbd",
"_type": "request",
"name": "Prints a document print template on a given printer. Simplified version.",
"description": "Version 2 provides well defined input parameters compared to version 1. It creates a print task with Digital Manufacturing context like plant, resource, order, work center, shop floor control and executes it in the asynchronous or synchronous mode. The task ID is returned. You can find the print task with its actual status in the Reprint Documents app. The printing process consists of data acquisition, document generation, and file transportation. Each step is done by a special plugin. Data acquisition and formatter plugins are assigned to a document print template in the Manage Print Templates app. The transport plugin is defined in the Manage Printers app. During the print task execution its status changes and the Updated Print Task event containing the context is produced. You can create a business rule in the Manage Automatic Triggers app for this event to trace the execution.",
"method": "POST",
"url": "{{ _.base_url }}/v2/print",
"parentId": "req_45aba9064fe0454d83327d16",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"document\": \"string\",\n \"plant\": \"string\",\n \"printer\": \"string\"\n}"
}
},
{
"_id": "req_2d69575b6c954ce29c03d9c1",
"_type": "request",
"name": "The service for CPS printing feedbacks.",
"description": "This service is used for Cloud Print Service (CPS) to send printing feedbacks to SAP Digital Manufacturing. It is supposed to be called only by CPS. You need to create a destination for this service and use it for the CPS configuration if you want to have an actual print status in SAP Digital Manufacturing.",
"method": "POST",
"url": "{{ _.base_url }}/v1/cpscallback",
"parentId": "req_45aba9064fe0454d83327d16",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "[\n {\n \"dateTime\": \"2024-01-01T00:00:00Z\",\n \"itemId\": \"string\",\n \"status\": \"string\"\n }\n]"
}
},
{
"_id": "req_8bb94455429a465db807c6db",
"_type": "request_group",
"name": "Printer",
"description": "Manage printers",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_621201ddf6b54755a63b2b01",
"_type": "request",
"name": "Retrieves a page of printers.",
"description": "Retrieves a page of printers or a specific printer defined in the request. If the sort parameter is not defined, the results are ordered by modified date-time in ascending order.",
"method": "GET",
"url": "{{ _.base_url }}/printers",
"parentId": "req_8bb94455429a465db807c6db",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "printer",
"value": "",
"description": "A printer for which a request is executed.",
"disabled": true
},
{
"name": "size",
"value": "",
"description": "The quantity of printer records to be returned. If it is not specified, the default value is 100. The maximum allowed value is 100.",
"disabled": true
},
{
"name": "page",
"value": "",
"description": "The number of a page to be returned. The page number starts from 0. If it is not defined, the first page is returned.",
"disabled": true
},
{
"name": "sort",
"value": "",
"description": "This parameter is used for sorting. To define the sorting order, use comma-separated values, like 'printer,desc'. The default sorting order is ascending. The following sorting parameters are supported: modifiedOn, createdOn, printer, description, and status.",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_96e4d77a33b3442aba3272e5",
"_type": "request",
"name": "Creates a printer.",
"description": "Creates a printer by the given request.",
"method": "POST",
"url": "{{ _.base_url }}/printers",
"parentId": "req_8bb94455429a465db807c6db",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"plugin\": \"string\",\n \"printer\": \"string\"\n}"
}
},
{
"_id": "req_bc3298ce667644bfba61dae9",
"_type": "request",
"name": "Updates a printer.",
"description": "Updates a printer by the given request.",
"method": "PATCH",
"url": "{{ _.base_url }}/printers",
"parentId": "req_8bb94455429a465db807c6db",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"modifiedOn\": \"2024-01-01T00:00:00Z\",\n \"printer\": \"string\"\n}"
}
},
{
"_id": "req_9c882eda99934ed2bccdfbaf",
"_type": "request",
"name": "Deletes a printer",
"description": "Deletes a printer by the given printer name.",
"method": "DELETE",
"url": "{{ _.base_url }}/printers",
"parentId": "req_8bb94455429a465db807c6db",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "printer",
"value": "",
"description": "A printer for deletion",
"disabled": false
}
],
"authentication": {}
},
{
"_id": "req_b23f67c05109420789e71e70",
"_type": "request_group",
"name": "Problem-Solving Process",
"description": "Allows you to create, read, and update problem-solving processes in SAP Digital Manufacturing for Issue Resolution",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_e1884f044a59474c9a51e061",
"_type": "request",
"name": "Retrieves a list of problem-solving processes.",
"description": "Retrieves a list of problem-solving processes",
"method": "GET",
"url": "{{ _.base_url }}/ProblemSolvingProcess",
"parentId": "req_b23f67c05109420789e71e70",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "$filter",
"value": "",
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
"disabled": true
},
{
"name": "$select",
"value": "",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"disabled": true
},
{
"name": "$expand",
"value": "",
"description": "The value of $expand query option is a comma-separated list of navigation property names, stream property names, or $value indicating the stream content of a media-entity. The corresponding related entities and stream values will be represented inline, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"disabled": true
},
{
"name": "$orderby",
"value": "",
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_22f1c27052744769a928bd9c",
"_type": "request",
"name": "Creates a problem-solving process.",
"description": "Creates a problem-solving process",
"method": "POST",
"url": "{{ _.base_url }}/ProblemSolvingProcess",
"parentId": "req_b23f67c05109420789e71e70",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"customerProblemDescription\": \"string\",\n \"defectCode\": \"string\",\n \"defectCodeGroup\": \"string\",\n \"methodologyId\": \"string\",\n \"notificationId\": \"string\",\n \"notificationItem\": \"string\",\n \"partnerOrgId\": \"string\",\n \"plant\": \"string\",\n \"processDescription\": \"string\",\n \"product\": \"string\",\n \"scenarioId\": \"string\",\n \"sourceSystemId\": \"string\",\n \"subjectCode\": \"string\",\n \"subjectCodeGroup\": \"string\",\n \"to_SourceReference\": {},\n \"to_Step\": {}\n}"
}
},
{
"_id": "req_6d4fec00c8694e89b99e7706",
"_type": "request",
"name": "Retrieves all values of a problem-solving process.",
"description": "Retrieves all values of a problem-solving process",
"method": "GET",
"url": "{{ _.base_url }}/ProblemSolvingProcess('{processId}')",
"parentId": "req_b23f67c05109420789e71e70",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "$select",
"value": "",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"disabled": true
},
{
"name": "$expand",
"value": "",
"description": "The value of $expand query option is a comma-separated list of navigation property names, stream property names, or $value indicating the stream content of a media-entity. The corresponding related entities and stream values will be represented inline, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_9e8e815a80064af599bf731e",
"_type": "request",
"name": "Updates a problem-solving process.",
"description": "Updates a problem-solving process",
"method": "PATCH",
"url": "{{ _.base_url }}/ProblemSolvingProcess('{processId}')",
"parentId": "req_b23f67c05109420789e71e70",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"confirmationStatusId\": \"string\",\n \"processDescription\": \"string\",\n \"processId\": \"string\",\n \"processStatusId\": \"string\",\n \"processUUID\": \"string\"\n}"
}
},
{
"_id": "req_d2d44b17f89146ed95191264",
"_type": "request",
"name": "Deletes a problem-solving process.",
"description": "Deletes a problem-solving process",
"method": "DELETE",
"url": "{{ _.base_url }}/ProblemSolvingProcess('{processId}')",
"parentId": "req_b23f67c05109420789e71e70",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {}
},
{
"_id": "req_e68751958697428688c749f2",
"_type": "request",
"name": "Retrieves all values of each root cause from all the problem-solving processes.",
"description": "Retrieves all values of each root cause from all the problem-solving processes",
"method": "GET",
"url": "{{ _.base_url }}/RootCause",
"parentId": "req_b23f67c05109420789e71e70",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "$filter",
"value": "",
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
"disabled": true
},
{
"name": "$orderby",
"value": "",
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
"disabled": true
},
{
"name": "$select",
"value": "",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"disabled": true
},
{
"name": "$expand",
"value": "",
"description": "The value of $expand query option is a comma-separated list of navigation property names, stream property names, or $value indicating the stream content of a media-entity. The corresponding related entities and stream values will be represented inline, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_833ef78ccc43453db3634c26",
"_type": "request",
"name": "Creates a root cause for a problem-solving process.",
"description": "Creates a root cause for a problem-solving process",
"method": "POST",
"url": "{{ _.base_url }}/RootCause",
"parentId": "req_b23f67c05109420789e71e70",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"processId\": \"string\",\n \"rootCauseDescription\": \"string\",\n \"stepTypeId\": \"string\"\n}"
}
},
{
"_id": "req_b65cd71251bb48bcb692b26c",
"_type": "request",
"name": "Retrieves all values of a root cause of a problem-solving process.",
"description": "Retrieves all values of a root cause of a problem-solving proces.",
"method": "GET",
"url": "{{ _.base_url }}/RootCause(rootCauseUUID={rootCauseUUID},stepUUID={stepUUID})",
"parentId": "req_b23f67c05109420789e71e70",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "$select",
"value": "",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"disabled": true
},
{
"name": "$expand",
"value": "",
"description": "The value of $expand query option is a comma-separated list of navigation property names, stream property names, or $value indicating the stream content of a media-entity. The corresponding related entities and stream values will be represented inline, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_2fed21cab5d5433a8ed8b5c8",
"_type": "request",
"name": "Updates a root cause of a problem-solving process.",
"description": "Updates a root cause of a problem-solving process",
"method": "PATCH",
"url": "{{ _.base_url }}/RootCause(rootCauseUUID={rootCauseUUID},stepUUID={stepUUID})",
"parentId": "req_b23f67c05109420789e71e70",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"codeGroupCatalogId\": \"string\",\n \"headerUUID\": \"string\",\n \"processId\": \"string\",\n \"processUUID\": \"string\",\n \"rootCauseCode\": \"string\",\n \"rootCauseCodeGroup\": \"string\",\n \"rootCauseDescription\": \"string\",\n \"rootCauseDetailDescription\": \"string\",\n \"rootCauseId\": \"string\",\n \"rootCauseType\": \"string\",\n \"stepTypeId\": \"string\"\n}"
}
},
{
"_id": "req_9971e17eadc54ad4ab415788",
"_type": "request",
"name": "Retrieves all values of a problem-solving process step.",
"description": "Retrieves all values of a problem-solving process step",
"method": "GET",
"url": "{{ _.base_url }}/Step(stepTypeId='{stepTypeId}',processId='{processId}')",
"parentId": "req_b23f67c05109420789e71e70",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "$select",
"value": "",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"disabled": true
},
{
"name": "$expand",
"value": "",
"description": "The value of $expand query option is a comma-separated list of navigation property names, stream property names, or $value indicating the stream content of a media-entity. The corresponding related entities and stream values will be represented inline, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_8d514f936d044a27b5164c66",
"_type": "request",
"name": "Updates a step of a problem-solving process.",
"description": "Updates a step of a problem-solving process",
"method": "PATCH",
"url": "{{ _.base_url }}/Step(stepTypeId='{stepTypeId}',processId='{processId}')",
"parentId": "req_b23f67c05109420789e71e70",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"processId\": \"string\",\n \"processUUID\": \"string\",\n \"stepReviewStatusId\": \"string\",\n \"stepStatusId\": \"string\",\n \"stepTypeId\": \"string\",\n \"stepUUID\": \"string\"\n}"
}
},
{
"_id": "req_8bad0e75c8fc4965a16f0ef8",
"_type": "request",
"name": "Creates a comment for a problem-solving process step.",
"description": "Creates a comment for a problem-solving process step",
"method": "POST",
"url": "{{ _.base_url }}/StepComments",
"parentId": "req_b23f67c05109420789e71e70",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"comment\": \"string\",\n \"commentCategory\": \"string\",\n \"processId\": \"string\",\n \"processUUID\": \"string\"\n}"
}
},
{
"_id": "req_2681c9b7219a411b8f630b6c",
"_type": "request",
"name": "Retrieves all tasks from each step in all problem-solving processes.",
"description": "Retrieves all tasks from each step in all problem-solving processes",
"method": "GET",
"url": "{{ _.base_url }}/Tasks",
"parentId": "req_b23f67c05109420789e71e70",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "$filter",
"value": "",
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
"disabled": true
},
{
"name": "$orderby",
"value": "",
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
"disabled": true
},
{
"name": "$select",
"value": "",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"disabled": true
},
{
"name": "$expand",
"value": "",
"description": "The value of $expand query option is a comma-separated list of navigation property names, stream property names, or $value indicating the stream content of a media-entity. The corresponding related entities and stream values will be represented inline, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_f95460e4222e4df3ac65d763",
"_type": "request",
"name": "Creates a task in a problem-solving process step.",
"description": "Creates a task in a problem-solving process step",
"method": "POST",
"url": "{{ _.base_url }}/Tasks",
"parentId": "req_b23f67c05109420789e71e70",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"descriptionShort\": \"string\",\n \"processId\": \"string\",\n \"stepTypeId\": \"string\"\n}"
}
},
{
"_id": "req_71ef8b637ea6458c8c617eaf",
"_type": "request",
"name": "Retrieves all values of a task within a step of a problem-solving process.",
"description": "Retrieves all values of a task within a step of a problem-solving proces.",
"method": "GET",
"url": "{{ _.base_url }}/Tasks(processId='{processId}',stepTypeId='{stepTypeId}',taskNumber='{taskNumber}')",
"parentId": "req_b23f67c05109420789e71e70",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {}
},
{
"_id": "req_93835f26c1ea428ea6621898",
"_type": "request",
"name": "Updates a task within a step of a problem-solving process.",
"description": "Updates a task within a step of a problem-solving process",
"method": "PATCH",
"url": "{{ _.base_url }}/Tasks(processId='{processId}',stepTypeId='{stepTypeId}',taskNumber='{taskNumber}')",
"parentId": "req_b23f67c05109420789e71e70",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"codeGroupCatalogId\": \"string\",\n \"codeGroupId\": \"string\",\n \"codeId\": \"string\",\n \"descriptionLong\": \"string\",\n \"descriptionShort\": \"string\",\n \"isLongTerm\": true,\n \"processId\": \"string\",\n \"processor\": \"string\",\n \"stepTypeId\": \"string\",\n \"taskNumber\": \"string\"\n}"
}
},
{
"_id": "req_aca8b23bcaad45519b995beb",
"_type": "request",
"name": "Retrieves all the team members from all the problem-solving processes.",
"description": "Retrieves all the team members from all the problem-solving processes",
"method": "GET",
"url": "{{ _.base_url }}/TeamMembers",
"parentId": "req_b23f67c05109420789e71e70",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "$filter",
"value": "",
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
"disabled": true
},
{
"name": "$orderby",
"value": "",
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
"disabled": true
},
{
"name": "$select",
"value": "",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"disabled": true
},
{
"name": "$expand",
"value": "",
"description": "The value of $expand query option is a comma-separated list of navigation property names, stream property names, or $value indicating the stream content of a media-entity. The corresponding related entities and stream values will be represented inline, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_f4d840aee6f74b1e9830cd27",
"_type": "request",
"name": "Adds team members to the D1 step of a problem-solving process.",
"description": "Adds team members to the D1 step of a problem-solving process",
"method": "POST",
"url": "{{ _.base_url }}/TeamMembers",
"parentId": "req_b23f67c05109420789e71e70",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"processId\": \"string\",\n \"stepTypeId\": \"string\",\n \"teamMemberId\": \"string\",\n \"teamMemberRoleId\": \"string\",\n \"teamMemberTypeId\": \"string\"\n}"
}
},
{
"_id": "req_ef88740a4c654698aed34b92",
"_type": "request",
"name": "Retrieves all values of a team member of a problem-solving process.",
"description": "Retrieves all values of a team member of a problem-solving process",
"method": "GET",
"url": "{{ _.base_url }}/TeamMembers(stepTypeId='{stepTypeId}',processId='{processId}',teamMemberId='{teamMemberId}')",
"parentId": "req_b23f67c05109420789e71e70",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "$select",
"value": "",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"disabled": true
},
{
"name": "$expand",
"value": "",
"description": "The value of $expand query option is a comma-separated list of navigation property names, stream property names, or $value indicating the stream content of a media-entity. The corresponding related entities and stream values will be represented inline, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_01f6a3fbbae34f2994c0f83e",
"_type": "request",
"name": "Updates team members of a problem-solving process.",
"description": "Updates team members of a problem-solving process",
"method": "PATCH",
"url": "{{ _.base_url }}/TeamMembers(stepTypeId='{stepTypeId}',processId='{processId}',teamMemberId='{teamMemberId}')",
"parentId": "req_b23f67c05109420789e71e70",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"isContactPerson\": true,\n \"processId\": \"string\",\n \"sendEmail\": true,\n \"stepTypeId\": \"string\",\n \"teamMemberRoleId\": \"string\",\n \"teamMemberRoleUUID\": \"string\",\n \"teamMemberTypeId\": \"string\"\n}"
}
},
{
"_id": "req_5110c2734ffd4b8b9d9c9078",
"_type": "request_group",
"name": "Process Lot",
"description": "Perform update and start activities on Process Lot",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_d36ee2dd8b3d49188cfcdfd6",
"_type": "request",
"name": "Updates a Process Lot by adding members.",
"description": "This endpoint can be called to add members to the existing Process Lot. The required parameters are plant, process lot number, members, and the modified date and time.",
"method": "POST",
"url": "{{ _.base_url }}/processLot/members",
"parentId": "req_5110c2734ffd4b8b9d9c9078",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"number\": \"string\",\n \"plant\": \"string\"\n}"
}
},
{
"_id": "req_913ec07226794b1eb4355b1c",
"_type": "request",
"name": "Start a Process Lot.",
"description": "This endpoint initiates processing activity for a specified process lot within a particular plant. To start the process lot, all SFCs associated with it must be on the same routing, at the same operation activity, have the same status, and be assigned to the same resource.",
"method": "POST",
"url": "{{ _.base_url }}/processLot/start",
"parentId": "req_5110c2734ffd4b8b9d9c9078",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"operation\": \"string\",\n \"plant\": \"string\",\n \"processLot\": \"string\",\n \"resource\": \"string\"\n}"
}
},
{
"_id": "req_681b9f5e1d0c4787866c4956",
"_type": "request_group",
"name": "Process Lot",
"description": "Perform create, read, update and delete activities on Process Lot",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_457c66ba75e04f559ce8ee17",
"_type": "request",
"name": "Finds a Process Lot by Plant and Process Lot Number.",
"description": "This endpoint can be called to obtain a single Process Lot. As a search parameters it uses Plant and Process Lot Number.",
"method": "GET",
"url": "{{ _.base_url }}/processLot",
"parentId": "req_681b9f5e1d0c4787866c4956",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "processLot",
"value": "",
"description": "Process Lot Number",
"disabled": false
},
{
"name": "plant",
"value": "",
"description": "The Plant where the Process Lot is used",
"disabled": false
}
],
"authentication": {}
},
{
"_id": "req_f872aaa4860548238acb8f3b",
"_type": "request",
"name": "Creates a Process Lot.",
"description": "This endpoint can be called to create a new Process Lot. The required parameters are Plant and Process Lot Number. Process Lot Members are optional.",
"method": "POST",
"url": "{{ _.base_url }}/processLot",
"parentId": "req_681b9f5e1d0c4787866c4956",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"number\": \"string\",\n \"plant\": \"string\"\n}"
}
},
{
"_id": "req_203bce7e300343c1bc73b456",
"_type": "request",
"name": "Deletes a Process Lot by Plant and Process Lot Number.",
"description": "This endpoint can be called to delete the Process Lot without Members. As parameters it uses Plant and Process Lot Number.",
"method": "DELETE",
"url": "{{ _.base_url }}/processLot",
"parentId": "req_681b9f5e1d0c4787866c4956",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "processLot",
"value": "",
"description": "Process Lot Number",
"disabled": false
},
{
"name": "plant",
"value": "",
"description": "The Plant where the Process Lot is used",
"disabled": false
}
],
"authentication": {}
},
{
"_id": "req_c0b005f4d99c4e189ebfec52",
"_type": "request",
"name": "Updates a Process Lot by adding Members.",
"description": "This endpoint can be called to add members to the existing Process Lot. The required parameters are plant, process lot number, members, and the modified date and time. This endpoint is now deprecated, please use the successor API Add Members To Process Lot",
"method": "POST",
"url": "{{ _.base_url }}/processLot/members",
"parentId": "req_681b9f5e1d0c4787866c4956",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"number\": \"string\",\n \"plant\": \"string\"\n}"
}
},
{
"_id": "req_3f2e32dacf124471aa878930",
"_type": "request",
"name": "Removes all Members.",
"description": "This endpoint can be called to remove all the Members of the Process Lot. As parameters it uses Plant and Process Lot Number.",
"method": "DELETE",
"url": "{{ _.base_url }}/processLot/members",
"parentId": "req_681b9f5e1d0c4787866c4956",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "processLot",
"value": "",
"description": "Process Lot Number",
"disabled": false
},
{
"name": "plant",
"value": "",
"description": "The Plant where the Process Lot is used",
"disabled": false
}
],
"authentication": {}
},
{
"_id": "req_152c5a473399415291dcdb30",
"_type": "request",
"name": "Removes Members by Plant and Process Lot Number.",
"description": "This endpoint can be called to remove Members of the Process Lot. As parameters it uses Plant, Process Lot Number and list of Members.",
"method": "POST",
"url": "{{ _.base_url }}/processLot/removeMembers",
"parentId": "req_681b9f5e1d0c4787866c4956",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"number\": \"string\",\n \"plant\": \"string\"\n}"
}
},
{
"_id": "req_b2343bdfd44b4791b13f10ed",
"_type": "request",
"name": "Start a Process Lot.",
"description": "This endpoint initiates processing activity for a specified process lot within a particular plant. To start the process lot, all SFCs associated with it must be on the same routing, at the same operation activity, have the same status, and be assigned to the same resource.This endpoint is now deprecated, please use the successor API Start a Process Lot",
"method": "POST",
"url": "{{ _.base_url }}/processLot/start",
"parentId": "req_681b9f5e1d0c4787866c4956",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"operation\": \"string\",\n \"plant\": \"string\",\n \"processLot\": \"string\",\n \"resource\": \"string\"\n}"
}
},
{
"_id": "req_4979d5f9aa754a8f9eaa898d",
"_type": "request",
"name": "Complete a Process Lot.",
"description": "This endpoint is used to complete a process lot within a particular plant. To complete the process lot, all SFCs associated with it must be on the same routing, at the same operation activity, have the same status, and be assigned to the same resource",
"method": "POST",
"url": "{{ _.base_url }}/processLot/complete",
"parentId": "req_681b9f5e1d0c4787866c4956",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"operation\": \"string\",\n \"plant\": \"string\",\n \"processLot\": \"string\",\n \"resource\": \"string\"\n}"
}
},
{
"_id": "req_c2851862a7b24cd6863e6a55",
"_type": "request_group",
"name": "Process Manufacturing Execution",
"description": "Perform production activities for a production order or process order, such as start an operation activity, complete an operation activity",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_06eb3ab7c86b4c248afa45c7",
"_type": "request",
"name": "Starts an Operation activity.",
"description": "Starts an Operation activity at the default or alternate resource of a work center at user-specified time or in real time.",
"method": "POST",
"url": "{{ _.base_url }}/operationActivity/start",
"parentId": "req_c2851862a7b24cd6863e6a55",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"operationActivity\": \"string\",\n \"order\": \"string\",\n \"plant\": \"string\",\n \"sfc\": \"string\",\n \"workCenter\": \"string\"\n}"
}
},
{
"_id": "req_8474a17fed5c4166b42db7dd",
"_type": "request",
"name": "Completes an Operation activity.",
"description": "Completes an operation activity at the default or alternate resource of a work center at user-specified time or in real time.",
"method": "POST",
"url": "{{ _.base_url }}/operationActivity/complete",
"parentId": "req_c2851862a7b24cd6863e6a55",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"operationActivity\": \"string\",\n \"order\": \"string\",\n \"plant\": \"string\",\n \"sfc\": \"string\",\n \"workCenter\": \"string\"\n}"
}
},
{
"_id": "req_10e5edad02c042bfb84e8577",
"_type": "request_group",
"name": "Process Order Execution",
"description": "Perform production activities for a process order",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_8d36f9db94904d4d825f7989",
"_type": "request",
"name": "Starts a phase.",
"description": "Starts a phase at the default resource of a work center at user-specified time or in real time. Be aware that the API is deprecated, and will be decommissioned and retired from production in a few releases. It's recommended to use the new successor API /operationActivity/start.",
"method": "POST",
"url": "{{ _.base_url }}/v1/phase/start",
"parentId": "req_10e5edad02c042bfb84e8577",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"order\": \"string\",\n \"phase\": \"string\",\n \"plant\": \"string\",\n \"workCenter\": \"string\"\n}"
}
},
{
"_id": "req_267721e26ab04841b5403ce5",
"_type": "request",
"name": "Completes a phase.",
"description": "Completes a phase at the default resource of a work center at user-specified time or in real time. Be aware that the API is deprecated, and will be decommissioned and retired from production in a few releases. It's recommended to use the new successor API /operationActivity/complete.",
"method": "POST",
"url": "{{ _.base_url }}/v1/phase/complete",
"parentId": "req_10e5edad02c042bfb84e8577",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"order\": \"string\",\n \"phase\": \"string\",\n \"plant\": \"string\",\n \"workCenter\": \"string\"\n}"
}
},
{
"_id": "req_27b34e095f3841cfbcbb092b",
"_type": "request",
"name": "Performs goods issue.",
"description": "Performs goods issue for a BOM or non-BOM component.",
"method": "POST",
"url": "{{ _.base_url }}/v1/goodsissue",
"parentId": "req_10e5edad02c042bfb84e8577",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"component\": {\n \"material\": {\n \"material\": \"string\",\n \"version\": \"string\"\n }\n },\n \"isBomComponent\": true,\n \"order\": \"string\",\n \"phase\": \"string\",\n \"plant\": \"string\",\n \"postedBy\": \"string\",\n \"postingDateTime\": \"string\",\n \"quantity\": 0.0,\n \"unitOfMeasure\": \"string\",\n \"workCenter\": \"string\"\n}"
}
},
{
"_id": "req_7b33b190d762454ab8d0a838",
"_type": "request",
"name": "Cancels a goods issue.",
"description": "Cancels a goods issue that has been successfully posted in SAP Digital Manufacturing as well as the integrated ERP or EWM systems.",
"method": "POST",
"url": "{{ _.base_url }}/v1/goodsissue/cancellations",
"parentId": "req_10e5edad02c042bfb84e8577",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"plant\": \"string\",\n \"transactionId\": \"string\"\n}"
}
},
{
"_id": "req_2054269c6bf246f19d99e82e",
"_type": "request",
"name": "Goods Issue Summary",
"description": "Goods Issue summary results for an order and plant. Be aware that the API is deprecated, and will be decommissioned and retired from production in a few releases. It's recommended to use the new successor API /v2/goodsIssue/summary.",
"method": "GET",
"url": "{{ _.base_url }}/v1/goodsIssue/summary",
"parentId": "req_10e5edad02c042bfb84e8577",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "The good issue summary fetched for plant ",
"disabled": false
},
{
"name": "order",
"value": "",
"description": "The good issue summary fetched for order",
"disabled": false
},
{
"name": "material",
"value": "",
"description": "The good issue summary fetched for material",
"disabled": false
},
{
"name": "operationActivity",
"value": "",
"description": "The operationActivity for which the summary results are retrieved",
"disabled": false
},
{
"name": "stepId",
"value": "",
"description": "The stepId for which summary results are retrieved",
"disabled": false
}
],
"authentication": {}
},
{
"_id": "req_046ee154417c4a2bb79f369f",
"_type": "request",
"name": "Goods Issue Summary",
"description": "Goods Issue summary results for an order, sfc, operationActivity, stepId and plant.",
"method": "GET",
"url": "{{ _.base_url }}/v2/goodsIssue/summary",
"parentId": "req_10e5edad02c042bfb84e8577",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "The goods issue summary fetched for plant ",
"disabled": false
},
{
"name": "order",
"value": "",
"description": "The goods issue summary fetched for order",
"disabled": false
},
{
"name": "sfc",
"value": "",
"description": "The goods issue summary fetched for sfc",
"disabled": false
},
{
"name": "operationActivity",
"value": "",
"description": "The goods issue summary fetched for operationActivity",
"disabled": false
},
{
"name": "stepId",
"value": "",
"description": "The goods issue summary fetched for stepId",
"disabled": false
}
],
"authentication": {}
},
{
"_id": "req_6918442f2e214600bac8fcd9",
"_type": "request",
"name": "Confirms activities.",
"description": "Confirms activities at a phase of an order. Be aware that the API is deprecated, and will be decommissioned and retired from production in a few releases. It's recommended to use the new successor API /v1/confirm.",
"method": "POST",
"url": "{{ _.base_url }}/v1/activity/confirm",
"parentId": "req_10e5edad02c042bfb84e8577",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"activities\": [\n {\n \"activityId\": \"string\",\n \"postedBy\": \"string\",\n \"postingDateTime\": \"string\",\n \"quantity\": 0.0,\n \"unitOfMeasure\": \"string\"\n }\n ],\n \"order\": \"string\",\n \"phase\": \"string\",\n \"plant\": \"string\",\n \"workCenter\": \"string\"\n}"
}
},
{
"_id": "req_e5432cc251bb43afb6a2c4c5",
"_type": "request",
"name": "Update start time of a phase.",
"description": "Updates start time for a phase to user-specified time. We've deprecated this endpoint. We recommend using the successor API Update Phase Start Time instead.",
"method": "POST",
"url": "{{ _.base_url }}/v1/phase/updateStartTime",
"parentId": "req_10e5edad02c042bfb84e8577",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"order\": \"string\",\n \"phase\": \"string\",\n \"plant\": \"string\",\n \"sfc\": \"string\",\n \"updatedStartDateTime\": \"string\",\n \"workCenter\": \"string\"\n}"
}
},
{
"_id": "req_7da03ebaebc845c5bf17ea1b",
"_type": "request",
"name": "Update complete time of a phase.",
"description": "Updates the complete time for a phase to user-specified time.",
"method": "POST",
"url": "{{ _.base_url }}/v1/phase/updateCompleteTime",
"parentId": "req_10e5edad02c042bfb84e8577",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"order\": \"string\",\n \"phase\": \"string\",\n \"plant\": \"string\",\n \"sfc\": \"string\",\n \"updatedCompleteDateTime\": \"string\",\n \"workCenter\": \"string\"\n}"
}
},
{
"_id": "req_e4de68b319da4166942a287e",
"_type": "request_group",
"name": "Process Order Execution",
"description": "Update start time for a phase",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_fd644ebc13bf4a14b0a534af",
"_type": "request",
"name": "Update start time of a phase.",
"description": "Updates start time of a phase to user-specified time.",
"method": "POST",
"url": "{{ _.base_url }}/v2/phase/updateStartTime",
"parentId": "req_e4de68b319da4166942a287e",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"order\": \"string\",\n \"phase\": \"string\",\n \"plant\": \"string\",\n \"sfc\": \"string\",\n \"updatedStartDateTime\": \"2024-01-01T00:00:00Z\",\n \"workCenter\": \"string\"\n}"
}
},
{
"_id": "req_dfc34c62d45446eaa7bd61ff",
"_type": "request_group",
"name": "Product Genealogy Report (PGR) Assembly Components",
"description": "Create a product genealogy report for an assembly",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_6e001adc9fa44dfa84bca4b9",
"_type": "request",
"name": "Obtains assembly components by SFC and plant. It's deprecated. Please use https://api.sap.com/api/sapdme_assembly",
"description": "This endpoint can be called to get an asbuilt-report components list of a specified organization. If there is no specified organization, the endpoint returns self-organization data.",
"method": "GET",
"url": "{{ _.base_url }}/components",
"parentId": "req_dfc34c62d45446eaa7bd61ff",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "condensed",
"value": "",
"description": "Flag to get components grouped or to get all single records separately.",
"disabled": true
},
{
"name": "pageNumber",
"value": "",
"description": "Page index (starts from 0), default is 0.",
"disabled": true
},
{
"name": "pageSize",
"value": "",
"description": "Page size, default is 100.",
"disabled": true
},
{
"name": "plant",
"value": "",
"description": "Plant for which the request is executed.",
"disabled": false
},
{
"name": "plantOwnerOrgId",
"value": "",
"description": "ID of the organization which the plant belongs to. By default, the plant belongs to the current user\u2019s organization.",
"disabled": true
},
{
"name": "sfc",
"value": "",
"description": "The SFC number for which components need to be found.",
"disabled": false
}
],
"authentication": {}
},
{
"_id": "req_e09ebf9b5aad4ce599349138",
"_type": "request_group",
"name": "Production Change",
"description": "Perform production changes to a shop floor control",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_81a10eecc8264fd5b4162884",
"_type": "request",
"name": "Assigns a new routing or BOM to SFCs",
"description": "Assigns a new routing or BOM, or both, to specific SFCs in the discrete industry. Before making the change, make sure each SFC is only being processed at one operation if the current router has relaxed flow enabled.",
"method": "POST",
"url": "{{ _.base_url }}/changeProduction",
"parentId": "req_e09ebf9b5aad4ce599349138",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"plant\": \"string\",\n \"sfcs\": [\n {\n \"sfc\": \"string\"\n }\n ]\n}"
}
},
{
"_id": "req_b5f2efb45eab409586a8c890",
"_type": "request_group",
"name": "Production Change",
"description": "Perform production changes to a shop floor control",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_50d6017844b447e1930e31eb",
"_type": "request",
"name": "Assigns a new routing or a new Bill of Materials (BOM) to given Shop Floor Controls (SFCs)",
"description": "Assigns a new routing or a new Bill of Materials (BOM), or both to given Shop Floor Controls (SFCs) for discrete industry. Before you make the change, ensure that each SFC is being processed at one operation only with one execution status.",
"method": "POST",
"url": "{{ _.base_url }}/changeProduction",
"parentId": "req_b5f2efb45eab409586a8c890",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"plant\": \"string\",\n \"sfcs\": [\n \"string\"\n ]\n}"
}
},
{
"_id": "req_b8406a85c8f444b783811480",
"_type": "request_group",
"name": "Production Operator Dashboard",
"description": "Create, import, and export a Production Operator Dashboard",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_c5cfc5be32cf4f09b2cc77fa",
"_type": "request",
"name": "API to create a new POD given a POD configuration.",
"description": "This end point creates a new a POD with the given POD identity and configuration. The configuration must be a string representing a valid json.",
"method": "POST",
"url": "{{ _.base_url }}/configurations",
"parentId": "req_b8406a85c8f444b783811480",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"configData\": \"string\",\n \"plant\": \"string\",\n \"podId\": \"string\"\n}"
}
},
{
"_id": "req_d3a5841ca798453c8fe15299",
"_type": "request",
"name": "API to export a POD configuration.",
"description": "The end point retrieves a POD configuration and saves it to a local file system. If the call is made directly by supported browsers, the browser will prompt for a local file selection, otherwise a the configuration is returned directly as the output.",
"method": "GET",
"url": "{{ _.base_url }}/export",
"parentId": "req_b8406a85c8f444b783811480",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "The Plant for the exporting POD.",
"disabled": false
},
{
"name": "podId",
"value": "",
"description": "The POD identity.",
"disabled": false
}
],
"authentication": {}
},
{
"_id": "req_56c5db06cfc646258165d024",
"_type": "request",
"name": "API to import a POD configuration from a local file system and creating a new POD.",
"description": "The body of this call must conform to the requirements of HTTP form-data format.",
"method": "POST",
"url": "{{ _.base_url }}/import",
"parentId": "req_b8406a85c8f444b783811480",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {}
},
{
"_id": "req_f3eb063ce5fe4d30974e2de0",
"_type": "request_group",
"name": "Production Operator Dashboard Notification",
"description": "Notification to alert a custom plugin or user about an event that has occurred.",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_61b5ac9e21c54060854cbf0f",
"_type": "request",
"name": "Send a custom notification for consumption by subscribing custom POD plugins.",
"description": "Send a custom notification to subscribing custom POD plugins. The notification will be routed to any custom plugin that has subscribed to the given event and subscription values. Note that this API cannot send notifications for SAP internal events, such as SFC Start. See the POD Plugin Developer's Guide for details.",
"method": "POST",
"url": "{{ _.base_url }}/send",
"parentId": "req_f3eb063ce5fe4d30974e2de0",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"eventName\": \"string\",\n \"subscription\": {\n \"plant\": \"string\"\n }\n}"
}
},
{
"_id": "req_dd8e22ad77be486b829fc54a",
"_type": "request_group",
"name": "Quality Inspection",
"description": "Perform quality inspection related activities",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_fad9d9aebc724d15921de40c",
"_type": "request",
"name": "Check if the mandatory inspection characteristics are recorded for the given SFCs at the given steps.",
"description": "Before synchronizing the inspection results recorded in SAP Digital Manufacturing back to the integrated ERP system, check if all the mandatory inspection characteristics have been inspected.",
"method": "POST",
"url": "{{ _.base_url }}/mandatoryCharacteristics/checkResultsRecorded",
"parentId": "req_dd8e22ad77be486b829fc54a",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
},
{
"name": "Accept-Language",
"value": "",
"description": "The Accept-Language request HTTP header indicates the natural language and locale that the client prefers. It's an ISO language-region code. Valid values: [en, en-US, de, hu, ko, fr, es, zh-CN, zh-TW, ja, ru, tr, pt, pl, sk, cz, it, th, bg, ro, sv]."
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"items\": [\n {\n \"sfc\": \"string\",\n \"stepId\": \"string\"\n }\n ],\n \"plant\": \"string\"\n}"
}
},
{
"_id": "req_df7a1ae8f69e4a7c98a82fbd",
"_type": "request_group",
"name": "Quality Inspection",
"description": "Perform quality inspection related activities",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_4cdff8d9b51249929c0f9afa",
"_type": "request",
"name": "Retrieves single results for an inspection characteristic",
"description": "Retrieves single value results for an inspection characteristic of a given inspection lot.",
"method": "GET",
"url": "{{ _.base_url }}/lots/{inspectionLot}/operations/{inspectionOperation}/characteristics/{inspectionCharacteristic}/results",
"parentId": "req_df7a1ae8f69e4a7c98a82fbd",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "The plant for which the inspection results are retrieved",
"disabled": false
},
{
"name": "sfc",
"value": "",
"description": "The SFC for which which the inspection results are retrieved",
"disabled": false
},
{
"name": "inspectionPoint",
"value": "",
"description": "The inspection point number",
"disabled": false
},
{
"name": "pageNumber",
"value": "",
"description": "The current page index (starts from 0). Default index is 0.",
"disabled": true
},
{
"name": "pageSize",
"value": "",
"description": "Specify the page size that determines the number of single value results that are displayed at one time in one page. Default is 50 and the maximum allowed is 100.",
"disabled": true
},
{
"name": "sort",
"value": "",
"description": "Whether result set needs to be sorted",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_8a0610099b7e41a7b328a44e",
"_type": "request",
"name": "Record single results for an inspection characteristics.",
"description": "Record single-value results for an inspection characteristic for a given inspection lot.",
"method": "POST",
"url": "{{ _.base_url }}/lots/{inspectionLot}/operations/{inspectionOperation}/characteristics/{inspectionCharacteristic}/results",
"parentId": "req_df7a1ae8f69e4a7c98a82fbd",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"overwriteResult\": true,\n \"plant\": \"string\",\n \"sfc\": \"string\"\n}"
}
},
{
"_id": "req_53e0cd518f6641afbca5fc8a",
"_type": "request",
"name": "Get inspection lot details.",
"description": "Get inspection lot information for a given inspection lot.",
"method": "GET",
"url": "{{ _.base_url }}/lots/{inspectionLot}",
"parentId": "req_df7a1ae8f69e4a7c98a82fbd",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "The plant where inspection lot information is retrieved",
"disabled": false
},
{
"name": "includingOperationsWithoutCharacteristic",
"value": "",
"description": "Set it to 'true' if you want to include operations that don't have assigned characteristics in the response.",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_fbd0fdfffd174214a9388e98",
"_type": "request",
"name": "Get inspection operation information.",
"description": "Get inspection operation information for a specific inspection operation of an inspection lot.",
"method": "GET",
"url": "{{ _.base_url }}/lots/{inspectionLot}/operations/{inspectionOperation}",
"parentId": "req_df7a1ae8f69e4a7c98a82fbd",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "The plant where inspection operation information is retrieved",
"disabled": false
}
],
"authentication": {}
},
{
"_id": "req_b48ce2c195cc49d59ebb95d0",
"_type": "request",
"name": "Get all the inspection characteristics",
"description": "Get all the inspection characteristics for a specific inspection operation of an inspection lot.",
"method": "GET",
"url": "{{ _.base_url }}/lots/{inspectionLot}/operations/{inspectionOperation}/characteristics",
"parentId": "req_df7a1ae8f69e4a7c98a82fbd",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "The plant where inspection characteristics are retrieved.",
"disabled": false
}
],
"authentication": {}
},
{
"_id": "req_6eccc958ac224f62adebb7b4",
"_type": "request",
"name": "Get inspection operation single results for inspection lot (multiple SFCs).",
"description": "Get recorded single results for an inspection operation for a given inspection lot for given multiple SFCs.",
"method": "GET",
"url": "{{ _.base_url }}/lots/{inspectionLot}/operations/{inspectionOperation}/results",
"parentId": "req_df7a1ae8f69e4a7c98a82fbd",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "The plant in which the inspection results are retrieved.",
"disabled": false
},
{
"name": "sfcs",
"value": "",
"description": "The SFCs for which the inspection results are retrieved",
"disabled": false
}
],
"authentication": {}
},
{
"_id": "req_a08227ab4d444dbeb28077a3",
"_type": "request",
"name": "Get inspection point field combination information.",
"description": "Get inspection point field combination information for a given field combination ID. The prerequisites of using the API is that you have configured inspection points in the Configure Inspection Points app in SAP Digital Manufacturing. This service is applicable to process orders and order-based production orders in integration with SAP S/4HANA.",
"method": "GET",
"url": "{{ _.base_url }}/inspectionPointCombinations/{combinationId}/userFields",
"parentId": "req_df7a1ae8f69e4a7c98a82fbd",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {}
},
{
"_id": "req_32325946be8f4a2d877b5469",
"_type": "request",
"name": "Create an inspection point.",
"description": "Create an inspection point for a given inspection operation of an inspection lot. The inspection point is created in SAP Digital Manufacturing only and is not synchronized to integrated ERP systems. /nThe prerequisites of using the API is that you have configured inspection points in the Configure Inspection Points app in SAP Digital Manufacturing. This service is applicable to process orders and order-based production orders in integration with SAP S/4HANA.",
"method": "POST",
"url": "{{ _.base_url }}/lots/{inspectionLot}/operations/{inspectionOperation}/points",
"parentId": "req_df7a1ae8f69e4a7c98a82fbd",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"plant\": \"string\",\n \"sfc\": \"string\"\n}"
}
},
{
"_id": "req_258ae3ec97194300a0bdaa5d",
"_type": "request",
"name": "Synchronizes the inspection point created in SAP Digital Manufacturing to the integrated ERP system. If the sync call succeeds, the inspection point is created in ERP.",
"description": "Synchronizes the created inspection point to the integrated ERP system for an inspection operation of a given inspection lot",
"method": "POST",
"url": "{{ _.base_url }}/lots/{inspectionLot}/operations/{inspectionOperation}/points/createInERP",
"parentId": "req_df7a1ae8f69e4a7c98a82fbd",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"inspectionPoint\": \"string\",\n \"plant\": \"string\",\n \"sfc\": \"string\"\n}"
}
},
{
"_id": "req_98ec989104094c4c861faf1a",
"_type": "request",
"name": "Synchronizes inspection single results to ERP",
"description": "Synchronizes inspection single results recorded in SAP Digital Manufacturing back to integrated ERP system for all characteristics under an inspection operation of a given inspection lot.",
"method": "POST",
"url": "{{ _.base_url }}/lots/{inspectionLot}/operations/{inspectionOperation}/results/recordInERP",
"parentId": "req_df7a1ae8f69e4a7c98a82fbd",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"plant\": \"string\",\n \"sfc\": \"string\"\n}"
}
},
{
"_id": "req_8f55c1b5f5974bb3964d7192",
"_type": "request",
"name": "Check if the mandatory inspection characteristics are recorded for the given SFCs at the given steps",
"description": "Before synchronizing the inspection results recorded in SAP Digital Manufacturing back to the integrated ERP system, check if all the mandatory inspection characteristics have been inspected.",
"method": "POST",
"url": "{{ _.base_url }}/mandatoryCharacteristics/checkResultsRecorded",
"parentId": "req_df7a1ae8f69e4a7c98a82fbd",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
},
{
"name": "Accept-Language",
"value": "",
"description": "The Accept-Language request HTTP header indicates the natural language and locale that the client prefers. It's an ISO language-region code. Valid values: [en, en-US, de, hu, ko, fr, es, zh-CN, zh-TW, ja, ru, tr, pt, pl, sk, cz, it, th, bg, ro, sv]."
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"items\": [\n {\n \"sfc\": \"string\",\n \"stepId\": \"string\"\n }\n ],\n \"plant\": \"string\"\n}"
}
},
{
"_id": "req_2f63ab6cd3964a1ebcd2bdce",
"_type": "request_group",
"name": "Quantity Confirmation",
"description": "Perform quantity confirmations for an order",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_1e98da71bd96459daacd38fe",
"_type": "request",
"name": "Post quantity confirmation for a given order.",
"description": "Post yield or scrap quantity confirmation for a given SFC of an order.",
"method": "POST",
"url": "{{ _.base_url }}/quantityConfirmation/v1/confirm",
"parentId": "req_2f63ab6cd3964a1ebcd2bdce",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"operationActivity\": \"string\",\n \"plant\": \"string\",\n \"sfc\": \"string\",\n \"shopOrder\": \"string\",\n \"workCenter\": \"string\"\n}"
}
},
{
"_id": "req_34f72d3ce72640bab9aabfab",
"_type": "request",
"name": "Post final quantity confirmation without updating the quantity for a given SFC of an order.",
"description": "Post final quantity confirmation without updating the quantity for a given SFC of an order. When the API call succeeds, the operation/phase status will be set to 'CNF' in the integrated ERP system.",
"method": "POST",
"url": "{{ _.base_url }}/quantityConfirmation/v1/reportOperationActivityFinalConfirmation",
"parentId": "req_2f63ab6cd3964a1ebcd2bdce",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"operationActivity\": \"string\",\n \"plant\": \"string\",\n \"sfc\": \"string\",\n \"shopOrder\": \"string\"\n}"
}
},
{
"_id": "req_d733c626f7f04af0af35bb25",
"_type": "request",
"name": "Get quantity confirmation postings",
"description": "Combine quantity confirmation details and summary for a given plant, SFC, and operation activity.",
"method": "GET",
"url": "{{ _.base_url }}/quantityConfirmation/v1/postings",
"parentId": "req_2f63ab6cd3964a1ebcd2bdce",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "Plant for quantity confirmation postings retrieval",
"disabled": false
},
{
"name": "sfc",
"value": "",
"description": "SFC for quantity confirmation postings retrieval",
"disabled": false
},
{
"name": "operationActivity",
"value": "",
"description": "OperationActivity for quantity confirmation postings retrieval",
"disabled": false
}
],
"authentication": {}
},
{
"_id": "req_ac2fbc68e4be4228a1776f74",
"_type": "request",
"name": "Get quantity confirmation posting history",
"description": "Get a list of quantity confirmation posting history entries for a given order, plant, and SFC",
"method": "GET",
"url": "{{ _.base_url }}/quantityConfirmation/v1/postingHistory",
"parentId": "req_2f63ab6cd3964a1ebcd2bdce",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "order",
"value": "",
"description": "The order for which you want to retrieve the quantity confirmation posting history",
"disabled": false
},
{
"name": "plant",
"value": "",
"description": "The plant for which you want to retrieve the quantity confirmation posting history",
"disabled": false
},
{
"name": "sfc",
"value": "",
"description": "The SFC for which you want to retrieve the quantity confirmation posting history",
"disabled": true
},
{
"name": "page",
"value": "",
"description": "The current page index (starts from 0). Default index is 0.",
"disabled": true
},
{
"name": "size",
"value": "",
"description": "Specify the page size that determines the number of posting results that are displayed at one time on one page. Default is 50 and the maximum allowed is 100.",
"disabled": true
},
{
"name": "sort",
"value": "",
"description": "Sorting criteria in the format: property,(asc|desc). The property we support are [SFC, OperationActivity, CreatedDateTime, PostingDateTime], Default is SFC. The default sort order is ascending.",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_0afde9de07cb4ebfb29b660b",
"_type": "request_group",
"name": "Recipe",
"description": "Perform read, create, update and delete Recipes",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_f83dca5044344cea81de460b",
"_type": "request",
"name": "Finds a recipe by plant, recipe name, recipe type, and recipe version",
"description": "This endpoint can be called to find a recipe by search parameters. The required parameters are plant, recipe name. The version is optional. If a version is not present, the current recipe version will be returned. The recipe type is optional, the default value is PRODUCTION",
"method": "GET",
"url": "{{ _.base_url }}/recipes",
"parentId": "req_0afde9de07cb4ebfb29b660b",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "The plant for which the request is executed.",
"disabled": false
},
{
"name": "recipe",
"value": "",
"description": "The recipe name.",
"disabled": false
},
{
"name": "recipeType",
"value": "",
"description": "The type of the recipe.",
"disabled": true
},
{
"name": "version",
"value": "",
"description": "The version of the recipe.",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_72c3240ad55f46a2a794d471",
"_type": "request",
"name": "Creates a list of recipes.",
"description": "Creates a list of recipes for the given plant.",
"method": "POST",
"url": "{{ _.base_url }}/recipes",
"parentId": "req_0afde9de07cb4ebfb29b660b",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "[\n {\n \"automaticGoodsReceipt\": true,\n \"createdDateTime\": \"2024-01-01T00:00:00Z\",\n \"currentVersion\": true,\n \"customValues\": [\n {\n \"attribute\": {},\n \"value\": {}\n }\n ],\n \"description\": \"string\",\n \"entryPhaseId\": \"string\",\n \"modifiedDateTime\": \"2024-01-01T00:00:00Z\",\n \"operationGroups\": [\n {\n \"description\": {},\n \"recipeOperationGroup\": {},\n \"recipeOperationGroupSteps\": {}\n }\n ],\n \"phases\": [\n {\n \"controlKey\": {},\n \"description\": {},\n \"donePhaseId\": {},\n \"entry\": {},\n \"holdPhaseId\": {},\n \"lastReportingPhase\": {},\n \"nextPhaseList\": {},\n \"phaseId\": {},\n \"productionProcessDefKey\": {},\n \"productionProcessId\": {},\n \"queueDecisionType\": {},\n \"recipeLink\": {},\n \"recipeOperation\": {},\n \"recipePhaseComponentList\": {},\n \"recipeReturnPhase\": {},\n \"recipeScrapPhase\": {},\n \"reportingStep\": {},\n \"returnPhaseId\": {},\n \"rework\": {},\n \"scrapPhaseId\": {},\n \"workCenter\": {}\n }\n ],\n \"plant\": \"string\",\n \"quantityValidation\": true,\n \"recipe\": \"string\",\n \"relaxedFlow\": true,\n \"status\": \"string\",\n \"type\": \"string\",\n \"version\": \"string\"\n }\n]"
}
},
{
"_id": "req_4f4a029c92fa4628b7799d79",
"_type": "request",
"name": "Updates a list of recipes.",
"description": "Updates a list of recipes for the given plant. If the hasBeenReleased property is set to true, then the following fields are updated:\n - the description, current version, quantity validation, entry phase ID, custom values, and operation groups fields of a recipe;\n - the description, entry, work center, production process ID fields of a recipe phase;\n - the weight relevant field of a recipe operation phase;\n - the tolerance over and under fields of a recipe phase component.",
"method": "PUT",
"url": "{{ _.base_url }}/recipes",
"parentId": "req_0afde9de07cb4ebfb29b660b",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "[\n {\n \"automaticGoodsReceipt\": true,\n \"createdDateTime\": \"2024-01-01T00:00:00Z\",\n \"currentVersion\": true,\n \"customValues\": [\n {\n \"attribute\": {},\n \"value\": {}\n }\n ],\n \"description\": \"string\",\n \"entryPhaseId\": \"string\",\n \"modifiedDateTime\": \"2024-01-01T00:00:00Z\",\n \"operationGroups\": [\n {\n \"description\": {},\n \"recipeOperationGroup\": {},\n \"recipeOperationGroupSteps\": {}\n }\n ],\n \"phases\": [\n {\n \"controlKey\": {},\n \"description\": {},\n \"donePhaseId\": {},\n \"entry\": {},\n \"holdPhaseId\": {},\n \"lastReportingPhase\": {},\n \"nextPhaseList\": {},\n \"phaseId\": {},\n \"productionProcessDefKey\": {},\n \"productionProcessId\": {},\n \"queueDecisionType\": {},\n \"recipeLink\": {},\n \"recipeOperation\": {},\n \"recipePhaseComponentList\": {},\n \"recipeReturnPhase\": {},\n \"recipeScrapPhase\": {},\n \"reportingStep\": {},\n \"returnPhaseId\": {},\n \"rework\": {},\n \"scrapPhaseId\": {},\n \"workCenter\": {}\n }\n ],\n \"plant\": \"string\",\n \"quantityValidation\": true,\n \"recipe\": \"string\",\n \"relaxedFlow\": true,\n \"status\": \"string\",\n \"type\": \"string\",\n \"version\": \"string\"\n }\n]"
}
},
{
"_id": "req_77e6b23f0ada4e87a855c03f",
"_type": "request",
"name": "Deletes a recipe by plant, recipe name, recipe version, and recipe type.",
"description": "Deletes a recipe by plant, recipe name, version, and recipe type.",
"method": "DELETE",
"url": "{{ _.base_url }}/recipes",
"parentId": "req_0afde9de07cb4ebfb29b660b",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "The plant for which request is executed.",
"disabled": false
},
{
"name": "recipe",
"value": "",
"description": "The recipe name.",
"disabled": false
},
{
"name": "version",
"value": "",
"description": "The version of the recipe.",
"disabled": false
},
{
"name": "recipeType",
"value": "",
"description": "The type of the recipe.",
"disabled": false
}
],
"authentication": {}
},
{
"_id": "req_410ed950f5104205bfc59ed1",
"_type": "request",
"name": "Finds recipe header details by plant, recipe name, recipe type, and recipe version",
"description": "This endpoint can be called to find a recipe's header details by search parameters. The required parameters are plant, recipe name, and recipe type. The version is optional. If a version is not present, the current recipe version will be used.",
"method": "GET",
"url": "{{ _.base_url }}/recipes/headerDetails",
"parentId": "req_0afde9de07cb4ebfb29b660b",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "The plant for which the request is executed.",
"disabled": false
},
{
"name": "recipe",
"value": "",
"description": "The recipe name.",
"disabled": false
},
{
"name": "recipeType",
"value": "",
"description": "The type of the recipe.",
"disabled": false
},
{
"name": "version",
"value": "",
"description": "The version of the recipe.If not present, the current recipe version will be used.",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_a29205d9b1704dbd940e4955",
"_type": "request",
"name": "Updates the recipe header details.Every unspecified field will remain unchanged.",
"description": "This endpoint can be called to update a recipe's header details.",
"method": "PATCH",
"url": "{{ _.base_url }}/recipes/headerDetails",
"parentId": "req_0afde9de07cb4ebfb29b660b",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "The plant for which the request is executed.",
"disabled": false
},
{
"name": "recipe",
"value": "",
"description": "The recipe name.",
"disabled": false
},
{
"name": "recipeType",
"value": "",
"description": "The type of the recipe.",
"disabled": false
},
{
"name": "version",
"value": "",
"description": "The version of the recipe.",
"disabled": false
}
],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"currentVersion\": true,\n \"description\": \"string\",\n \"quantityValidation\": true,\n \"relaxedFlow\": true,\n \"status\": \"string\"\n}"
}
},
{
"_id": "req_389b812a837a48cb91642077",
"_type": "request",
"name": "Update the recipe header details and phases details.",
"description": "Update the recipe header details and phases details. Finds needed phases by phaseId and updates specified fields. Every unspecified field will remain unchanged.",
"method": "PATCH",
"url": "{{ _.base_url }}/recipes/{recipe}/{version}/{recipeType}/recipeDetailsAndPhases",
"parentId": "req_0afde9de07cb4ebfb29b660b",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "The plant for which request is executed.",
"disabled": false
}
],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"phases\": [\n {\n \"phaseId\": \"string\",\n \"productionProcessDefKey\": \"string\",\n \"productionProcessId\": \"string\",\n \"recipeOperation\": {\n \"weighRelevant\": {}\n }\n }\n ],\n \"quantityValidation\": true,\n \"relaxedFlow\": true\n}"
}
},
{
"_id": "req_477db2fdd31f405d85e18fee",
"_type": "request_group",
"name": "Resource",
"description": "Manage resources used to perform an operation in a manufacturing process",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_96fcd195998b47c9852de589",
"_type": "request",
"name": "Retrieves a list of resources.",
"description": "Retrieves a list of resources by plant or by resource name and plant.",
"method": "GET",
"url": "{{ _.base_url }}/v2/resources",
"parentId": "req_477db2fdd31f405d85e18fee",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "The plant containing a resource.",
"disabled": false
},
{
"name": "resource",
"value": "",
"description": "The name to retrieve a resource.",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_80e9d232123b4de4a2cb7ef7",
"_type": "request",
"name": "Creates a resource.",
"description": "Creates a resource by the given request.",
"method": "POST",
"url": "{{ _.base_url }}/v2/resources",
"parentId": "req_477db2fdd31f405d85e18fee",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"plant\": \"string\",\n \"resource\": \"string\"\n}"
}
},
{
"_id": "req_21f5e3ff23134be6b5401077",
"_type": "request",
"name": "Updates the resource.",
"description": "Updates the existing resource by the given request.",
"method": "PATCH",
"url": "{{ _.base_url }}/v2/resources",
"parentId": "req_477db2fdd31f405d85e18fee",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"plant\": \"string\",\n \"resource\": \"string\"\n}"
}
},
{
"_id": "req_8de03a71947441cdbfc99fdd",
"_type": "request",
"name": "Deletes the resource.",
"description": "Deletes the existing resource by the given request.",
"method": "DELETE",
"url": "{{ _.base_url }}/v2/resources",
"parentId": "req_477db2fdd31f405d85e18fee",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {}
},
{
"_id": "req_87a27998a8c346c7853ca509",
"_type": "request",
"name": "Retrieves a single resource.",
"description": "Retrieves a resource by plant and resource name.",
"method": "GET",
"url": "{{ _.base_url }}/v3/resource",
"parentId": "req_477db2fdd31f405d85e18fee",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "The plant containing a resource.",
"disabled": false
},
{
"name": "resource",
"value": "",
"description": "The name to retrieve a resource.",
"disabled": false
}
],
"authentication": {}
},
{
"_id": "req_216876ba2ffb48708e482308",
"_type": "request",
"name": "Retrieves a page of resources.",
"description": "Retrieves a list of resources by plant or by resource name and plant.",
"method": "GET",
"url": "{{ _.base_url }}/v3/resources",
"parentId": "req_477db2fdd31f405d85e18fee",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "The plant containing a resource.",
"disabled": false
},
{
"name": "size",
"value": "",
"description": "The quantity of resource records to be returned. If it is not specified, the default value is 100. The maximum allowed value is 100.",
"disabled": true
},
{
"name": "page",
"value": "",
"description": "The number of a page to be returned. The page number starts with 0. If it is not defined, the first page is returned.",
"disabled": true
},
{
"name": "sort",
"value": "",
"description": "This parameter is used for sorting. To define the sorting order, use comma-separated values, like 'resource,desc'. The default sorting order is ascending. The following sorting parameters are supported: modifiedDateTime, createdDateTime, resource, description, and status.",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_894ae5c1387047049572f58a",
"_type": "request",
"name": "Creates a resource.",
"description": "Creates a resource by the given request.",
"method": "POST",
"url": "{{ _.base_url }}/v3/resources",
"parentId": "req_477db2fdd31f405d85e18fee",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"plant\": \"string\",\n \"resource\": \"string\"\n}"
}
},
{
"_id": "req_6f01b6f4799c48a39b8be6dd",
"_type": "request",
"name": "Updates the resource.",
"description": "Updates the existing resource by the given request.",
"method": "PATCH",
"url": "{{ _.base_url }}/v3/resources",
"parentId": "req_477db2fdd31f405d85e18fee",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"modifiedDateTime\": \"2024-01-01T00:00:00Z\",\n \"plant\": \"string\",\n \"resource\": \"string\"\n}"
}
},
{
"_id": "req_ec896ab58a6b4a8a8e82de46",
"_type": "request",
"name": "Changes the resource status.",
"description": "Changes the status of the provided resource based on the provided parameters.",
"method": "POST",
"url": "{{ _.base_url }}/v2/changestatus",
"parentId": "req_477db2fdd31f405d85e18fee",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"plant\": \"string\",\n \"resource\": \"string\",\n \"status\": \"string\",\n \"user\": \"string\"\n}"
}
},
{
"_id": "req_dcaa92021e8145a2902677ce",
"_type": "request",
"name": "Loads a resource bin.",
"description": "Requires a material or inventory that is in the assembly data fields (INVENTORY_ID, INVENTORY_ID_SFC, or SFC). If there is an inventory in the assembly data fields its size will be decreased by the loaded bin quantity. If the Bin is already loaded new loading will be added to the queue.",
"method": "POST",
"url": "{{ _.base_url }}/v2/loadbin",
"parentId": "req_477db2fdd31f405d85e18fee",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"assemblyDataFields\": [\n {\n \"field\": \"string\"\n }\n ],\n \"bin\": \"string\",\n \"plant\": \"string\",\n \"resource\": \"string\"\n}"
}
},
{
"_id": "req_f23414deb29d46cbbe326f86",
"_type": "request",
"name": "Unloads a resource bin.",
"description": "When you unload a resource bin that has been loaded from the inventory, the quantity in the bin is returned to the inventory.",
"method": "POST",
"url": "{{ _.base_url }}/v2/unloadbin",
"parentId": "req_477db2fdd31f405d85e18fee",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"bin\": \"string\",\n \"plant\": \"string\",\n \"resource\": \"string\"\n}"
}
},
{
"_id": "req_60f7d0b67e9f4175a7eec987",
"_type": "request",
"name": "Retrieves a list of custom field definitions for the resource.",
"description": "Returns all maintained custom field definitions, for a given plant.",
"method": "GET",
"url": "{{ _.base_url }}/v2/customFieldDefinitions",
"parentId": "req_477db2fdd31f405d85e18fee",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "The plant where a custom field definitions are defined.",
"disabled": false
}
],
"authentication": {}
},
{
"_id": "req_2b3c7137f5eb4bf8a155e909",
"_type": "request",
"name": "Creates a custom field definition for the resource.",
"description": "Creates a custom field definition for the resource by the given request.",
"method": "POST",
"url": "{{ _.base_url }}/v2/customFieldDefinitions",
"parentId": "req_477db2fdd31f405d85e18fee",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"fieldName\": \"string\",\n \"plant\": \"string\"\n}"
}
},
{
"_id": "req_35f125cdb5fe46f892bb93b7",
"_type": "request",
"name": "Updates a custom field definition for the resource.",
"description": "Updates field label or sequence in the custom field definition for the resource.",
"method": "PATCH",
"url": "{{ _.base_url }}/v2/customFieldDefinitions",
"parentId": "req_477db2fdd31f405d85e18fee",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"fieldName\": \"string\",\n \"modifiedDateTime\": \"2024-01-01T00:00:00Z\",\n \"plant\": \"string\"\n}"
}
},
{
"_id": "req_82af680d905047c3afdf3c83",
"_type": "request",
"name": "Deletes a custom field definition for the resource.",
"description": "Deletes the existing custom field definition for the resource by the given request.",
"method": "DELETE",
"url": "{{ _.base_url }}/v2/customFieldDefinitions",
"parentId": "req_477db2fdd31f405d85e18fee",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {}
},
{
"_id": "req_53788282b0e54c2a801f17d7",
"_type": "request_group",
"name": "Resource",
"description": "Manage resources used to perform an operation in a manufacturing process",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_1f7cd83f7e6e4662bcabe87f",
"_type": "request",
"name": "Changes the resource status.",
"description": "Changes the status of the provided resource based on the provided parameters. Please use successor API: Resource V2.",
"method": "POST",
"url": "{{ _.base_url }}/changestatus",
"parentId": "req_53788282b0e54c2a801f17d7",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"plant\": \"string\",\n \"resource\": \"string\",\n \"status\": \"string\",\n \"user\": \"string\"\n}"
}
},
{
"_id": "req_7ae9b9bb4c8d48d0ae40ff23",
"_type": "request",
"name": "Loads a resource bin.",
"description": "Requires a material or inventory that is in the assembly data fields (INVENTORY_ID, INVENTORY_ID_SFC, or SFC). If there is an inventory in the assembly data fields its size will be decreased by the loaded bin quantity. If the Bin is already loaded new loading will be added to the queue. Please use successor API: Resource V2.",
"method": "POST",
"url": "{{ _.base_url }}/loadbin",
"parentId": "req_53788282b0e54c2a801f17d7",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"assemblyDataFields\": [\n {\n \"field\": \"string\"\n }\n ],\n \"bin\": \"string\",\n \"plant\": \"string\",\n \"resource\": \"string\"\n}"
}
},
{
"_id": "req_140fe80d4740473394e688c4",
"_type": "request",
"name": "Retrieves a list of resources.",
"description": "Retrieves a list of resources by plant or by resource name and plant. Deprecated for tenants that have activated the Enterprise Asset Base Model (EABM) service. Please use successor API: Resource V2.",
"method": "GET",
"url": "{{ _.base_url }}/resources",
"parentId": "req_53788282b0e54c2a801f17d7",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "The plant containing a resource.",
"disabled": false
},
{
"name": "resource",
"value": "",
"description": "The name to retrieve a resource.",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_a64440e83b054d4c9c3fd984",
"_type": "request",
"name": "Creates a resource.",
"description": "Creates a resource by the given request. Deprecated for tenants that have activated the Enterprise Asset Base Model (EABM) service. Please use successor API: Resource V2.",
"method": "POST",
"url": "{{ _.base_url }}/resources",
"parentId": "req_53788282b0e54c2a801f17d7",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"plant\": \"string\",\n \"resource\": \"string\"\n}"
}
},
{
"_id": "req_7c1681c088d64efdab216517",
"_type": "request",
"name": "Updates the resource.",
"description": "Updates the existing resource by the given request. Deprecated for tenants that have activated the Enterprise Asset Base Model (EABM) service. Please use successor API: Resource V2.",
"method": "PATCH",
"url": "{{ _.base_url }}/resources",
"parentId": "req_53788282b0e54c2a801f17d7",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"plant\": \"string\",\n \"resource\": \"string\"\n}"
}
},
{
"_id": "req_2c99e50bad2e462ea1f1df9f",
"_type": "request",
"name": "Deletes the resource.",
"description": "Deletes the existing resource by the given request. Please use successor API: Resource V2.",
"method": "DELETE",
"url": "{{ _.base_url }}/resources",
"parentId": "req_53788282b0e54c2a801f17d7",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {}
},
{
"_id": "req_e32e430e483143f6b9214af1",
"_type": "request",
"name": "Unloads a resource bin.",
"description": "When you unload a resource bin that has been loaded from the inventory, the quantity in the bin is returned to the inventory. Please use successor API: Resource V2.",
"method": "POST",
"url": "{{ _.base_url }}/unloadbin",
"parentId": "req_53788282b0e54c2a801f17d7",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"bin\": \"string\",\n \"plant\": \"string\",\n \"resource\": \"string\"\n}"
}
},
{
"_id": "req_96af2707c53743a38323d7ed",
"_type": "request_group",
"name": "Resource Reason Code",
"description": "Retrieve resource reason code using machine code and resource.",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_b8608130a27e4651a10d18e4",
"_type": "request",
"name": "Retrieve resource reason code",
"description": "Retrieves resource reason code for the provided machine code and resource.",
"method": "GET",
"url": "{{ _.base_url }}/v1/resourceReasonCodes",
"parentId": "req_96af2707c53743a38323d7ed",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "Plant for retrieving resource reason code.",
"disabled": false
},
{
"name": "resource",
"value": "",
"description": "Resource name for retrieving resource reason code.",
"disabled": false
},
{
"name": "machineCode",
"value": "",
"description": "Machine code name for retrieving resource reason code.",
"disabled": false
}
],
"authentication": {}
},
{
"_id": "req_307e847023f043f18bff1db9",
"_type": "request_group",
"name": "Resource Type",
"description": "Maintain resource types for a given plant.",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_13e8cf7979b24671987580df",
"_type": "request",
"name": "Searches for resource types by name.",
"description": "Finds a resource type containing resources by plant and name",
"method": "GET",
"url": "{{ _.base_url }}/resourcetypes",
"parentId": "req_307e847023f043f18bff1db9",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "The plant where a resource type is defined.",
"disabled": false
},
{
"name": "resourceType",
"value": "",
"description": "The resource type value.",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_6aa3138ec60d43b697d292cf",
"_type": "request",
"name": "Creates a resource type.",
"description": "Creates a resource type with associated resources",
"method": "POST",
"url": "{{ _.base_url }}/resourcetypes",
"parentId": "req_307e847023f043f18bff1db9",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"createdOn\": \"2024-01-01T00:00:00Z\",\n \"description\": \"string\",\n \"modifiedOn\": \"2024-01-01T00:00:00Z\",\n \"plant\": \"string\",\n \"resourceType\": \"string\",\n \"resources\": [\n {\n \"plant\": \"string\",\n \"resource\": \"string\"\n }\n ]\n}"
}
},
{
"_id": "req_1727173409944fb8bb345716",
"_type": "request",
"name": "Updates a resource type.",
"description": "Updates a resource type for a given plant",
"method": "PATCH",
"url": "{{ _.base_url }}/resourcetypes",
"parentId": "req_307e847023f043f18bff1db9",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"createdOn\": \"2024-01-01T00:00:00Z\",\n \"description\": \"string\",\n \"modifiedOn\": \"2024-01-01T00:00:00Z\",\n \"plant\": \"string\",\n \"resourceType\": \"string\",\n \"resources\": [\n {\n \"plant\": \"string\",\n \"resource\": \"string\"\n }\n ]\n}"
}
},
{
"_id": "req_f5e31234df98437b9f1a18ab",
"_type": "request",
"name": "Removes the given resource type.",
"description": "Removes the resource type for a given plant.",
"method": "DELETE",
"url": "{{ _.base_url }}/resourcetypes",
"parentId": "req_307e847023f043f18bff1db9",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {}
},
{
"_id": "req_a62e9581f5b94cac9369ef58",
"_type": "request_group",
"name": "Routing",
"description": "Perform read, create, update and delete Routings",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_ee84fb0d09c94147962d088c",
"_type": "request",
"name": "Finds a routing by plant, routing name, routing type, and routing version",
"description": "This endpoint can be called to find a routing by search parameters. The required parameters are plant, routing name, and type. The version is optional. If a version is not present, the current routing version will be returned.",
"method": "GET",
"url": "{{ _.base_url }}/routings",
"parentId": "req_a62e9581f5b94cac9369ef58",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "Plant for which request is executed",
"disabled": false
},
{
"name": "routing",
"value": "",
"description": "Routing name",
"disabled": false
},
{
"name": "type",
"value": "",
"description": "Routing type. \nPossible values: \nPRODUCTION - Production Router; \nSHOP_ORDER - Shop Order-specific Router; \nSPECIAL - Special Operation Router; \nNC - NC (Rework) Router); \nDISPOSITION - Disposition Router (used in disposition groups); \nCONFIGURABLE - Configurable Router Type; \n SERVICE_ORDER_ROUTING - Service Order Router Type.",
"disabled": false
},
{
"name": "version",
"value": "",
"description": "The version of the routing. If not present, the current routing version will be returned",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_9838f84d9fa94b22910fcb3b",
"_type": "request",
"name": "Creates a list of routings.",
"description": "Creates a list of routings for the given plant.",
"method": "POST",
"url": "{{ _.base_url }}/routings",
"parentId": "req_a62e9581f5b94cac9369ef58",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "[\n {\n \"automaticGoodsReceipt\": true,\n \"createdDateTime\": \"2024-01-01T00:00:00Z\",\n \"currentVersion\": true,\n \"customValues\": [\n {\n \"attribute\": {},\n \"value\": {}\n }\n ],\n \"description\": \"string\",\n \"entryRoutingStepId\": \"string\",\n \"modifiedDateTime\": \"2024-01-01T00:00:00Z\",\n \"plant\": \"string\",\n \"quantityValidation\": true,\n \"relaxedFlow\": true,\n \"routing\": \"string\",\n \"routingErpSequences\": [\n {\n \"branchOperation\": {},\n \"category\": {},\n \"description\": {},\n \"erpSequence\": {},\n \"referenceSequence\": {},\n \"returnOperation\": {}\n }\n ],\n \"routingOperationGroups\": [\n {\n \"description\": {},\n \"erpOperationNumber\": {},\n \"routingOperationGroup\": {},\n \"routingOperationGroupSteps\": {}\n }\n ],\n \"routingSteps\": [\n {\n \"controlKey\": {},\n \"description\": {},\n \"entry\": {},\n \"erpSequence\": {},\n \"lastReportingStep\": {},\n \"nextStepList\": {},\n \"productionProcessDefKey\": {},\n \"productionProcessId\": {},\n \"queueDecisionType\": {},\n \"reportingStep\": {},\n \"rework\": {},\n \"routingDoneStep\": {},\n \"routingHoldStep\": {},\n \"routingLink\": {},\n \"routingOperation\": {},\n \"routingReturnStep\": {},\n \"routingScrapStep\": {},\n \"routingStepComponentList\": {},\n \"routingStepGroup\": {},\n \"sequence\": {},\n \"stepId\": {},\n \"workCenter\": {}\n }\n ],\n \"routingType\": \"string\",\n \"status\": \"string\",\n \"version\": \"string\"\n }\n]"
}
},
{
"_id": "req_2f406a8feefe472d97ddf537",
"_type": "request",
"name": "Updates a list of routings.",
"description": "Updates a list of routings for the given plant. If the hasBeenReleased property is set to true, then the following fields are updated:\n - the description, current version, quantity validation, entry routing step ID, custom values, and routing operation groups fields of a routing;\n - the description, entry, work center, production process ID fields of a routing step;\n - the weight relevant field of a routing operation step;\n - the tolerance over and under fields of a routing step component.",
"method": "PUT",
"url": "{{ _.base_url }}/routings",
"parentId": "req_a62e9581f5b94cac9369ef58",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "[\n {\n \"automaticGoodsReceipt\": true,\n \"createdDateTime\": \"2024-01-01T00:00:00Z\",\n \"currentVersion\": true,\n \"customValues\": [\n {\n \"attribute\": {},\n \"value\": {}\n }\n ],\n \"description\": \"string\",\n \"entryRoutingStepId\": \"string\",\n \"modifiedDateTime\": \"2024-01-01T00:00:00Z\",\n \"plant\": \"string\",\n \"quantityValidation\": true,\n \"relaxedFlow\": true,\n \"routing\": \"string\",\n \"routingErpSequences\": [\n {\n \"branchOperation\": {},\n \"category\": {},\n \"description\": {},\n \"erpSequence\": {},\n \"referenceSequence\": {},\n \"returnOperation\": {}\n }\n ],\n \"routingOperationGroups\": [\n {\n \"description\": {},\n \"erpOperationNumber\": {},\n \"routingOperationGroup\": {},\n \"routingOperationGroupSteps\": {}\n }\n ],\n \"routingSteps\": [\n {\n \"controlKey\": {},\n \"description\": {},\n \"entry\": {},\n \"erpSequence\": {},\n \"lastReportingStep\": {},\n \"nextStepList\": {},\n \"productionProcessDefKey\": {},\n \"productionProcessId\": {},\n \"queueDecisionType\": {},\n \"reportingStep\": {},\n \"rework\": {},\n \"routingDoneStep\": {},\n \"routingHoldStep\": {},\n \"routingLink\": {},\n \"routingOperation\": {},\n \"routingReturnStep\": {},\n \"routingScrapStep\": {},\n \"routingStepComponentList\": {},\n \"routingStepGroup\": {},\n \"sequence\": {},\n \"stepId\": {},\n \"workCenter\": {}\n }\n ],\n \"routingType\": \"string\",\n \"status\": \"string\",\n \"version\": \"string\"\n }\n]"
}
},
{
"_id": "req_6a8176aba4c347a8bbf50a42",
"_type": "request",
"name": "Deletes a routing by plant, routing name, routing version, and routing type.",
"description": "Deletes a routing by plant, routing name, version, and type.",
"method": "DELETE",
"url": "{{ _.base_url }}/routings",
"parentId": "req_a62e9581f5b94cac9369ef58",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "The plant for which the request is executed",
"disabled": false
},
{
"name": "routing",
"value": "",
"description": "Routing name",
"disabled": false
},
{
"name": "version",
"value": "",
"description": "Routing version",
"disabled": false
},
{
"name": "type",
"value": "",
"description": "Routing type. \nPossible values: \nPRODUCTION - Production Router; \nSHOP_ORDER - Shop Order-specific Router; \nSPECIAL - Special Operation Router; \nNC - NC (Rework) Router); \nDISPOSITION - Disposition Router (used in disposition groups); \nCONFIGURABLE - Configurable Router Type;\n SERVICE_ORDER_ROUTING - Service Order Router Type.",
"disabled": false
}
],
"authentication": {}
},
{
"_id": "req_8660e26d9e74403991b5393f",
"_type": "request",
"name": "Finds a routing operation by plant, routing name, routing type, and routing version",
"description": "This endpoint can be called to find a routing operation by search parameters. The required parameters are plant, routing name, and type. The version is optional. If a version is not present, the current routing version will be used.",
"method": "GET",
"url": "{{ _.base_url }}/routings/routingOperations",
"parentId": "req_a62e9581f5b94cac9369ef58",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "A plant for which the request is executed",
"disabled": false
},
{
"name": "routing",
"value": "",
"description": "Routing name",
"disabled": false
},
{
"name": "type",
"value": "",
"description": "Routing type. \nPossible values: \nPRODUCTION - Production Router; \nSHOP_ORDER - Shop Order-specific Router; \nSPECIAL - Special Operation Router; \nNC - NC (Rework) Router); \nDISPOSITION - Disposition Router (used in disposition groups); \nCONFIGURABLE - Configurable Router Type;\n SERVICE_ORDER_ROUTING - Service Order Router Type.",
"disabled": false
},
{
"name": "version",
"value": "",
"description": "The version of the routing. If not present, the current routing version will be used",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_44fb540511b045beb4dc6799",
"_type": "request",
"name": "Finds a routing's steps by plant, routing name, routing type, and routing version",
"description": "This endpoint can be called to find a routing's basic steps by search parameters. The required parameters are plant, routing name, and type. The version is optional. If a version is not present, the current routing version will be used.",
"method": "GET",
"url": "{{ _.base_url }}/routings/routingSteps",
"parentId": "req_a62e9581f5b94cac9369ef58",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "A plant for which the request is executed",
"disabled": false
},
{
"name": "routing",
"value": "",
"description": "Routing name",
"disabled": false
},
{
"name": "type",
"value": "",
"description": "Routing type. \nPossible values: \nPRODUCTION - Production Router; \nSHOP_ORDER - Shop Order-specific Router; \nSPECIAL - Special Operation Router; \nNC - NC (Rework) Router); \nDISPOSITION - Disposition Router (used in disposition groups); \nCONFIGURABLE - Configurable Router Type;\n SERVICE_ORDER_ROUTING - Service Order Router Type.",
"disabled": false
},
{
"name": "version",
"value": "",
"description": "The version of the routing. If not present, the current routing version will be used",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_c64797afbfa14d9cb7a670b2",
"_type": "request",
"name": "Finds routing header details by plant, routing name, routing type, and routing version",
"description": "This endpoint can be called to find a routing's header details by search parameters. The required parameters are plant, routing name, and type. The version is optional. If a version is not present, the current routing version will be used.",
"method": "GET",
"url": "{{ _.base_url }}/routings/headerDetails",
"parentId": "req_a62e9581f5b94cac9369ef58",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "A plant for which the request is executed",
"disabled": false
},
{
"name": "routing",
"value": "",
"description": "The routing name",
"disabled": false
},
{
"name": "type",
"value": "",
"description": "The routing type. \nPossible values: \nPRODUCTION - Production Router; \nSHOP_ORDER - Shop Order-specific Router; \nSPECIAL - Special Operation Router; \nNC - NC (Rework) Router); \nDISPOSITION - Disposition Router (used in disposition groups); \nCONFIGURABLE - Configurable Router Type;\n SERVICE_ORDER_ROUTING - Service Order Router Type.",
"disabled": false
},
{
"name": "version",
"value": "",
"description": "The version of the routing. If not present, the current routing version will be used",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_6f67e1402a844ae5b459920a",
"_type": "request",
"name": "Update routing header details. Every unspecified field will remain unchanged",
"description": "This endpoint can be called to update a routing's header details.",
"method": "PATCH",
"url": "{{ _.base_url }}/routings/headerDetails",
"parentId": "req_a62e9581f5b94cac9369ef58",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "A plant for which the request is executed",
"disabled": false
},
{
"name": "routing",
"value": "",
"description": "The routing name",
"disabled": false
},
{
"name": "type",
"value": "",
"description": "The routing type. \nPossible values: \nPRODUCTION - Production Router; \nSHOP_ORDER - Shop Order-specific Router; \nSPECIAL - Special Operation Router; \nNC - NC (Rework) Router); \nDISPOSITION - Disposition Router (used in disposition groups); \nCONFIGURABLE - Configurable Router Type; \n SERVICE_ORDER_ROUTING - Service Order Router Type.",
"disabled": false
},
{
"name": "version",
"value": "",
"description": "The version of the routing. If not present, the current routing version will be used",
"disabled": true
}
],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"currentVersion\": true,\n \"description\": \"string\",\n \"quantityValidation\": true,\n \"relaxedFlow\": true,\n \"status\": \"string\"\n}"
}
},
{
"_id": "req_6ee28d79f5ad4b1ead772f1b",
"_type": "request_group",
"name": "Setpoint Activities",
"description": "Perform production-related tasks involving Setpoints",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_8afc6b453c6c4f06af8f4b6f",
"_type": "request",
"name": "Retrieves setpoint parameters or indicators based on a set of context criteria.",
"description": "This operation searches for all the released and current version setpoints that meet the given criteria.",
"method": "GET",
"url": "{{ _.base_url }}/find",
"parentId": "req_6ee28d79f5ad4b1ead772f1b",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
},
{
"name": "enableStrictFilter",
"value": "",
"description": "The enableStrictFilter header parameter can be used to specify the way filters are applied to the setpoint groups. By default this header parameter is set to false"
}
],
"parameters": [
{
"name": "material.name",
"value": "",
"description": "The material name is an optional context used to filter the setpoint groups for which the specified material is assigned to. If enableStrictFilter is set to true, the filter returns an exact match. If enableStrictFilter is set to false, the filter considers the setpoint groups assigned with the given material along with the setpoint groups without any material assignment.",
"disabled": true
},
{
"name": "material.version",
"value": "",
"description": "The material version is an optional context which should be provided if the material name is specified.",
"disabled": true
},
{
"name": "operation.name",
"value": "",
"description": "The operation name is an optional context used to filter the setpoint groups to which the specified operation is assigned to. If enableStrictFilter is set to true, the filter returns an exact match. If enableStrictFilter is set to false, the filter considers the setpoint groups assigned with the given operation along with the setpoint groups without any operation assignment.",
"disabled": true
},
{
"name": "operation.version",
"value": "",
"description": "The operation version is an optional context which should be provided if the operation name is specified.",
"disabled": true
},
{
"name": "parameter",
"value": "",
"description": "An optional parameter or indicator name used to filter the setpoint groups and parameters/indicators that are returned.",
"disabled": true
},
{
"name": "plant",
"value": "",
"description": "The plant is the location where the setpoint group is used.",
"disabled": false
},
{
"name": "resource",
"value": "",
"description": "The resource is a required context for setpoint groups.",
"disabled": false
},
{
"name": "setPointGroup",
"value": "",
"description": "An optional setpoint group name can be used to filter the setpoint groups that are returned.",
"disabled": true
},
{
"name": "sfcs",
"value": "",
"description": "An optional set of SFCs provided as additional context for setpoint groups. If enableStrictFilter is set to true, this filter parameter considers the setpoint groups assigned with order, material or routing associated with the specified SFCs. If enableStrictFilter is set to false, the setpoint groups assigned with order, material and routing associated with specified SFCs are considered along with the setpoint groups without respective assignments.",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_2dd1d18425dc4a7fb5e0a9e4",
"_type": "request",
"name": "Writes the values of Setpoint parameters/indicators that are found based on a set of context criteria to machine indicators.",
"description": "This operation can only be used with Setpoints that have an associated asset. Setpoints without an asset will be skipped, and Setpoints with parameters/indicators that do not correspond to an actual machine indicator will fail.",
"method": "POST",
"url": "{{ _.base_url }}/write",
"parentId": "req_6ee28d79f5ad4b1ead772f1b",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"plant\": \"string\",\n \"resource\": \"string\"\n}"
}
},
{
"_id": "req_8db10de257df442ba22f201b",
"_type": "request",
"name": "Retrieves the definitions of one or multiple Setpoint Groups.",
"description": "This operation is a query that returns one more setpoint groups for a give plant. You may also filter for a specific setpoint, status and version",
"method": "GET",
"url": "{{ _.base_url }}/groups",
"parentId": "req_6ee28d79f5ad4b1ead772f1b",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "page",
"value": "",
"description": "Start page, defaults to 0.",
"disabled": true
},
{
"name": "plant",
"value": "",
"description": "The Plant",
"disabled": false
},
{
"name": "setpointgroup",
"value": "",
"description": "The Setpoint Group name.",
"disabled": true
},
{
"name": "size",
"value": "",
"description": "Page size, defaults to 10 and max is 1000",
"disabled": true
},
{
"name": "status",
"value": "",
"description": "The Setpoint Group status.",
"disabled": true
},
{
"name": "version",
"value": "",
"description": "Setpoint Group version.",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_375d28eced48425680d80ad7",
"_type": "request",
"name": "Creates a Setpoint Group.",
"description": "This operation creates a Setpoint Group with its parameters/indicators, contexts, and custom values.",
"method": "POST",
"url": "{{ _.base_url }}/groups",
"parentId": "req_6ee28d79f5ad4b1ead772f1b",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"plant\": \"string\",\n \"setPointGroup\": \"string\",\n \"version\": \"string\"\n}"
}
},
{
"_id": "req_94c5f5db53704dde81b2bcd9",
"_type": "request",
"name": "Edits a Setpoint Group and its children collections, such as parameters/indicators.",
"description": "If the Setpoint Group is marked as used in production, it cannot be edited. Any optional values that are not specified in the request will be retained. If any child collections are modified, they will be replaced entirely.",
"method": "PATCH",
"url": "{{ _.base_url }}/groups",
"parentId": "req_6ee28d79f5ad4b1ead772f1b",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"plant\": \"string\",\n \"setPointGroup\": \"string\",\n \"version\": \"string\"\n}"
}
},
{
"_id": "req_97f7f727f84f43bfa5ff6a9b",
"_type": "request",
"name": "Deletes a Setpoint Group and all its children objects.",
"description": "If the Setpoint Group is marked as used in production, it cannot be deleted.",
"method": "DELETE",
"url": "{{ _.base_url }}/groups",
"parentId": "req_6ee28d79f5ad4b1ead772f1b",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "The Plant",
"disabled": false
},
{
"name": "setpointgroup",
"value": "",
"description": "The Setpoint Group name.",
"disabled": false
},
{
"name": "version",
"value": "",
"description": "Setpoint Group version.",
"disabled": false
}
],
"authentication": {}
},
{
"_id": "req_e29635991ab6497fbbcad2f7",
"_type": "request_group",
"name": "Setpoint Activities",
"description": "Perform production-related tasks involving Setpoints",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_923ea5d289f0471893163f75",
"_type": "request",
"name": "Retrieves applicable Setpoint parameters/indicators based on a set of context criteria.",
"description": "This operation searches for all the released and current version Setpoints that meet the given criteria.",
"method": "GET",
"url": "{{ _.base_url }}/find",
"parentId": "req_e29635991ab6497fbbcad2f7",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "material.name",
"value": "",
"description": "The material name is an optional context that can be used to narrow down the Setpoint Groups that are returned.",
"disabled": true
},
{
"name": "material.version",
"value": "",
"description": "The material version is an optional context that can be used to narrow down the Setpoint Groups that are returned.",
"disabled": true
},
{
"name": "operation.name",
"value": "",
"description": "The operation name is an optional context that can be used to narrow down the Setpoint Groups that are returned.",
"disabled": true
},
{
"name": "operation.version",
"value": "",
"description": "The operation version is an optional context that can be used to narrow down the Setpoint Groups that are returned.",
"disabled": true
},
{
"name": "parameter",
"value": "",
"description": "An optional Setpoint Group parameter/indicator name can be used to filter the Setpoint Groups and parameters/indicators that are returned.",
"disabled": true
},
{
"name": "plant",
"value": "",
"description": "The plant is the location where the Setpoint Group will be used.",
"disabled": false
},
{
"name": "resource",
"value": "",
"description": "The resource is a required context for Setpoint Groups.",
"disabled": false
},
{
"name": "setPointGroup",
"value": "",
"description": "An optional Setpoint Group name can be used to filter the Setpoint Groups that are returned.",
"disabled": true
},
{
"name": "sfcs",
"value": "",
"description": "An optional set of SFCs can be specified to provide additional context for Setpoint Groups.",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_27b26a24b697490bbc1074f2",
"_type": "request",
"name": "Writes the values of Setpoint parameters/indicators that are found based on a set of context criteria to machine indicators.",
"description": "This operation can only be used with Setpoints that have an associated asset. Setpoints without an asset will be skipped, and Setpoints with parameters/indicators that do not correspond to an actual machine indicator will fail.",
"method": "POST",
"url": "{{ _.base_url }}/write",
"parentId": "req_e29635991ab6497fbbcad2f7",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"plant\": \"string\",\n \"resource\": \"string\"\n}"
}
},
{
"_id": "req_ca94618c1908442cb93697a4",
"_type": "request",
"name": "Retrieves the definitions of one or multiple Setpoint Groups.",
"description": "This operation is a query that accepts group names and matches them starting with the specified string. The version, group names, and status must match exactly.",
"method": "GET",
"url": "{{ _.base_url }}/groups",
"parentId": "req_e29635991ab6497fbbcad2f7",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "page",
"value": "",
"description": "Start page, defaults to 0.",
"disabled": true
},
{
"name": "plant",
"value": "",
"description": "The Plant",
"disabled": false
},
{
"name": "setpointgroup",
"value": "",
"description": "The Setpoint Group name.",
"disabled": true
},
{
"name": "size",
"value": "",
"description": "Page size, defaults to 10 and max is 1000",
"disabled": true
},
{
"name": "status",
"value": "",
"description": "The Setpoint Group status.",
"disabled": true
},
{
"name": "version",
"value": "",
"description": "Setpoint Group version.",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_24420109682545e7909042b1",
"_type": "request",
"name": "Creates a Setpoint Group.",
"description": "This operation creates a Setpoint Group with its parameters/indicators, contexts, and custom values.",
"method": "POST",
"url": "{{ _.base_url }}/groups",
"parentId": "req_e29635991ab6497fbbcad2f7",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"plant\": \"string\",\n \"setPointGroup\": \"string\",\n \"version\": \"string\"\n}"
}
},
{
"_id": "req_0a7fdcbd8de94c5186279fca",
"_type": "request",
"name": "Edits a Setpoint Group and its children collections, such as parameters/indicators.",
"description": "If the Setpoint Group is marked as used in production, it cannot be edited. Any optional values that are not specified in the request will be retained. If any child collections are modified, they will be replaced entirely.",
"method": "PATCH",
"url": "{{ _.base_url }}/groups",
"parentId": "req_e29635991ab6497fbbcad2f7",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"plant\": \"string\",\n \"setPointGroup\": \"string\",\n \"version\": \"string\"\n}"
}
},
{
"_id": "req_d9fda0df722a4f9facafb067",
"_type": "request",
"name": "Deletes a Setpoint Group and all its children objects.",
"description": "If the Setpoint Group is marked as used in production, it cannot be deleted.",
"method": "DELETE",
"url": "{{ _.base_url }}/groups",
"parentId": "req_e29635991ab6497fbbcad2f7",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "The Plant",
"disabled": false
},
{
"name": "setpointgroup",
"value": "",
"description": "The Setpoint Group name.",
"disabled": false
},
{
"name": "version",
"value": "",
"description": "Setpoint Group version.",
"disabled": false
}
],
"authentication": {}
},
{
"_id": "req_a32642596ada4310852f6a3a",
"_type": "request_group",
"name": "Setpoint Activities",
"description": "Perform production Setpoint related activities",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_d7b162b3357f4728bf43e1ba",
"_type": "request",
"name": "Obtains applicable Setpoint parameters/indicators given a set of context criteria.",
"description": "This operation searches for all the released and current version Setpoints that meet the given set of criteria.",
"method": "GET",
"url": "{{ _.base_url }}/find",
"parentId": "req_a32642596ada4310852f6a3a",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "material.name",
"value": "",
"description": "Material name as part of a an optional material context under which a Setpoint Group takes effect or becomes valid.",
"disabled": true
},
{
"name": "material.version",
"value": "",
"description": "Material version as part of a an optional material context under which a Setpoint Group takes effect or becomes valid.",
"disabled": true
},
{
"name": "operation.name",
"value": "",
"description": "Operation name as part of a an optional operation context under which a Setpoint Group takes effect or becomes valid.",
"disabled": true
},
{
"name": "operation.version",
"value": "",
"description": "Operation version as part of a an optional operation context under which a Setpoint Group takes effect or becomes valid.",
"disabled": true
},
{
"name": "parameter",
"value": "",
"description": "An optional Setpoint Group single parameter/indicator name as a filter to narrow down Setpoint Groups and parameters/indicators for both find and write.",
"disabled": true
},
{
"name": "plant",
"value": "",
"description": "The plant in which the Setpoint Group will be used.",
"disabled": false
},
{
"name": "resource",
"value": "",
"description": "A resource as a required mandatory context for Setpoint Groups.",
"disabled": false
},
{
"name": "setPointGroup",
"value": "",
"description": "An optional Setpoint Group name as a filter to narrow down Setpoint Groups for both find and write.",
"disabled": true
},
{
"name": "sfcs",
"value": "",
"description": "An optional set of SFCs that can be specified providing additional context for Setpoint Groups.",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_58f425f6c6a445acb9634fba",
"_type": "request",
"name": "Writes Setpoint parameters/indicators found by attached set of context criteria to machine indicators",
"description": "This operation is only designed to work with those Setpoints that have specified an equipment. Setpoints with no equipment are skipped. Setpoints' parameters/indicators that do not correspond to an actual machine indicator cause failure.",
"method": "POST",
"url": "{{ _.base_url }}/write",
"parentId": "req_a32642596ada4310852f6a3a",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"plant\": \"string\",\n \"resource\": \"string\"\n}"
}
},
{
"_id": "req_09220dec7c6c4bfbb3f18946",
"_type": "request",
"name": "Retrieves defintions for one or multiple Setpoint Groups. ",
"description": "This is a query operation that accepts partial group names and does a starts with match. The match on version and status are exact. If both version and group are specified, then the group is also matched as exact.",
"method": "GET",
"url": "{{ _.base_url }}/groups",
"parentId": "req_a32642596ada4310852f6a3a",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "page",
"value": "",
"description": "Start page, defaults to 0.",
"disabled": true
},
{
"name": "plant",
"value": "",
"description": "The Plant",
"disabled": false
},
{
"name": "setpointgroup",
"value": "",
"description": "The Setpoint Group name.",
"disabled": true
},
{
"name": "size",
"value": "",
"description": "Page size, defaults to 10 and max is 1000",
"disabled": true
},
{
"name": "status",
"value": "",
"description": "The Setpoint Group status.",
"disabled": true
},
{
"name": "version",
"value": "",
"description": "Setpoint Group version.",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_efa047a5aded4cb18be1c5f8",
"_type": "request",
"name": "Creates a Setpoint Group.",
"description": "Creates a full or partial Setpoint Group with its parameters/indicators, contexts, and custom values.",
"method": "POST",
"url": "{{ _.base_url }}/groups",
"parentId": "req_a32642596ada4310852f6a3a",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"plant\": \"string\",\n \"setPointGroup\": \"string\",\n \"version\": \"string\"\n}"
}
},
{
"_id": "req_7b0d23fb78bc43259cd9a771",
"_type": "request",
"name": "Edits a Setpoint Group and children collections (e.g. parameters/indicators).",
"description": "If the given Setpoint Group is marked as used in production, the Setpoint Group can not be edited. Any non-required value omitted or set as null within the request body will not be subject to edit and will retain values. If children collection(s) are specified, the whole collection will be replaced.",
"method": "PATCH",
"url": "{{ _.base_url }}/groups",
"parentId": "req_a32642596ada4310852f6a3a",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"plant\": \"string\",\n \"setPointGroup\": \"string\",\n \"version\": \"string\"\n}"
}
},
{
"_id": "req_160fbba22dd447d38b56eea2",
"_type": "request",
"name": "Deletes a Setpoint Group and all its children objects",
"description": "If the given Setpoint Group is marked as used in production, the Setpoint Group can not be deleted.",
"method": "DELETE",
"url": "{{ _.base_url }}/groups",
"parentId": "req_a32642596ada4310852f6a3a",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "The Plant",
"disabled": false
},
{
"name": "setpointgroup",
"value": "",
"description": "The Setpoint Group name.",
"disabled": false
},
{
"name": "version",
"value": "",
"description": "Setpoint Group version.",
"disabled": false
}
],
"authentication": {}
},
{
"_id": "req_047db62776004c8c89b7edaf",
"_type": "request_group",
"name": "Shift",
"description": "Maintain shifts for a given plant",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_0273ce9b97ba4b6da2a92055",
"_type": "request",
"name": "Searches for shifts by plant and shift values.",
"description": "Searches for a shift for a given plant and returns the details for the same",
"method": "GET",
"url": "{{ _.base_url }}/shifts",
"parentId": "req_047db62776004c8c89b7edaf",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "The plant where a shift is defined.",
"disabled": false
},
{
"name": "shift",
"value": "",
"description": "The shift value.",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_fcc8387f97f0430b8e64fd47",
"_type": "request",
"name": "Creates a shift.",
"description": "Creates a shift for a given plant",
"method": "POST",
"url": "{{ _.base_url }}/shifts",
"parentId": "req_047db62776004c8c89b7edaf",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"category\": \"string\",\n \"plant\": \"string\",\n \"shift\": \"string\"\n}"
}
},
{
"_id": "req_745a30a6c2fa4d81a6e82657",
"_type": "request",
"name": "Updates the given shift.",
"description": "Updates a shift for a given plant",
"method": "PATCH",
"url": "{{ _.base_url }}/shifts",
"parentId": "req_047db62776004c8c89b7edaf",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"category\": \"string\",\n \"plant\": \"string\",\n \"shift\": \"string\"\n}"
}
},
{
"_id": "req_6bfacbe7705141f89147f70d",
"_type": "request",
"name": "Removes the given shift.",
"description": "Removes a shift for a given plant",
"method": "DELETE",
"url": "{{ _.base_url }}/shifts",
"parentId": "req_047db62776004c8c89b7edaf",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {}
},
{
"_id": "req_2c0e526988724a5cbf9e43b3",
"_type": "request",
"name": "Retrieves a list of custom field definitions for the shift.",
"description": "Returns all maintained custom field definitions, for a given plant.",
"method": "GET",
"url": "{{ _.base_url }}/customFieldDefinitions",
"parentId": "req_047db62776004c8c89b7edaf",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "The plant where a custom field definitions are defined.",
"disabled": false
}
],
"authentication": {}
},
{
"_id": "req_c96399bfca90455fbeffab5c",
"_type": "request",
"name": "Creates a custom field definition for the shift.",
"description": "Creates a custom field definition for the shift.",
"method": "POST",
"url": "{{ _.base_url }}/customFieldDefinitions",
"parentId": "req_047db62776004c8c89b7edaf",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"fieldName\": \"string\",\n \"plant\": \"string\"\n}"
}
},
{
"_id": "req_99348e1afcc74370b3669233",
"_type": "request",
"name": "Updates a custom field definition for the shift.",
"description": "Updates field label or sequence in the custom field definition for the shift.",
"method": "PATCH",
"url": "{{ _.base_url }}/customFieldDefinitions",
"parentId": "req_047db62776004c8c89b7edaf",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"fieldName\": \"string\",\n \"modifiedDateTime\": \"2024-01-01T00:00:00Z\",\n \"plant\": \"string\"\n}"
}
},
{
"_id": "req_2b68458151cf490facfa78e8",
"_type": "request",
"name": "Deletes a custom field definition for the shift.",
"description": "Deletes a custom field definition for the shift.",
"method": "DELETE",
"url": "{{ _.base_url }}/customFieldDefinitions",
"parentId": "req_047db62776004c8c89b7edaf",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {}
},
{
"_id": "req_631d0b545d894096b8316ea3",
"_type": "request_group",
"name": "Shop Floor Control Production Activities",
"description": "Perform production activities on a Shop Floor Control, such as start, complete, serialize, relabel, split, merge, scrap and set quantity",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_8ce8fb2485ac4d6a9286f441",
"_type": "request",
"name": "Starts one or more SFCs at an operation activity and resource.",
"description": "Moves the SFC quantity from an in queue status to an in work status at the operation activity. Multiple SFCs are started as a single atomic unit, meaning failure to start one SFC fails the start for all SFCs.",
"method": "POST",
"url": "{{ _.base_url }}/sfcs/start",
"parentId": "req_631d0b545d894096b8316ea3",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "async",
"value": "",
"description": "Provide a Boolean value for the request to be processed asynchronously.",
"disabled": true
}
],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"operation\": \"string\",\n \"plant\": \"string\",\n \"resource\": \"string\"\n}"
}
},
{
"_id": "req_4990253e028d4a558a08f0b1",
"_type": "request",
"name": "Serialize an SFC.",
"description": "Creates new SFCs with the quantity 1 from the given SFC. Decreases the original SFC quantity by the quantity of the created SFCs. If the SFC quantity becomes 0, then the SFC becomes invalid.",
"method": "POST",
"url": "{{ _.base_url }}/sfcs/serialize",
"parentId": "req_631d0b545d894096b8316ea3",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "async",
"value": "",
"description": "Provide a Boolean value for the request to be processed asynchronously.",
"disabled": true
}
],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"plant\": \"string\",\n \"sfc\": \"string\"\n}"
}
},
{
"_id": "req_cc5433882d694718a0e00b23",
"_type": "request",
"name": "Merge SFCs.",
"description": "Merges given SFCs into the parent SFC. Quantity of the parent SFC is increased by the total quantities of merged SFCs. Merged SFCs become invalid.",
"method": "POST",
"url": "{{ _.base_url }}/sfcs/merge",
"parentId": "req_631d0b545d894096b8316ea3",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "async",
"value": "",
"description": "Provide a Boolean value for the request to be processed asynchronously.",
"disabled": true
}
],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"parentSfc\": \"string\",\n \"plant\": \"string\",\n \"sourceSfcs\": [\n \"string\"\n ]\n}"
}
},
{
"_id": "req_45cb429da2614149a6b5724c",
"_type": "request",
"name": "Split an SFC.",
"description": "Creates new SFCs with the quantity from the original SFC. Decreases the original SFC quantity by the quantity of the new SFCs. The original SFC quantity remains the same and the total quantity of the new SFCs can be greater than the original one in case of overproduction. The remaining quantity of the original SFC must be greater than 0.",
"method": "POST",
"url": "{{ _.base_url }}/sfcs/split",
"parentId": "req_631d0b545d894096b8316ea3",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "async",
"value": "",
"description": "Provide a Boolean value for the request to be processed asynchronously.",
"disabled": true
}
],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"newSfcs\": [\n {\n \"quantity\": 0.0\n }\n ],\n \"plant\": \"string\",\n \"sfc\": \"string\"\n}"
}
},
{
"_id": "req_8f398ad43c42471d89f9af8a",
"_type": "request",
"name": "Scraps one or more SFCs at an operation activity and resource.",
"description": "You scrap an SFC when the material is no longer viable for production. If the SFC is an assembly, then all assembled child SFCs are also scrapped. The status of each scrapped SFC is set to Scrapped.",
"method": "POST",
"url": "{{ _.base_url }}/sfcs/scrap",
"parentId": "req_631d0b545d894096b8316ea3",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "async",
"value": "",
"description": "Provide a Boolean value for the request to be processed asynchronously.",
"disabled": true
}
],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"plant\": \"string\",\n \"quantity\": 0.0,\n \"sfcs\": [\n \"string\"\n ]\n}"
}
},
{
"_id": "req_22349d31678e47eea8c54184",
"_type": "request",
"name": "Relabel an SFC.",
"description": "Creates a new SFC with the given name and the same quantity as the given SFC. The original SFC becomes invalid.",
"method": "POST",
"url": "{{ _.base_url }}/sfcs/relabel",
"parentId": "req_631d0b545d894096b8316ea3",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "async",
"value": "",
"description": "Provide a Boolean value for the request to be processed asynchronously.",
"disabled": true
}
],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"newSfc\": \"string\",\n \"plant\": \"string\",\n \"sfc\": \"string\"\n}"
}
},
{
"_id": "req_62347aed88a14d4bb0798406",
"_type": "request",
"name": "Sets SFC quantities.",
"description": "Sets the new quantities of the SFCs.",
"method": "POST",
"url": "{{ _.base_url }}/sfcs/setQuantity",
"parentId": "req_631d0b545d894096b8316ea3",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"plant\": \"string\",\n \"sfcQuantityRequests\": [\n {\n \"quantity\": 0.0,\n \"sfc\": \"string\"\n }\n ]\n}"
}
},
{
"_id": "req_ad96031b17614a30a68b6ab3",
"_type": "request",
"name": "Completes one or more SFCs at an operation activity and resource.",
"description": "The SFCs are moved to the next operation activity, or set to the Done status if they have completed the last operation activity on the routing.",
"method": "POST",
"url": "{{ _.base_url }}/sfcs/complete",
"parentId": "req_631d0b545d894096b8316ea3",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "async",
"value": "",
"description": "Provide a Boolean value for the request to be processed asynchronously.",
"disabled": true
}
],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"operation\": \"string\",\n \"plant\": \"string\",\n \"resource\": \"string\"\n}"
}
},
{
"_id": "req_20a4765bc0ea4b06b2a34e5c",
"_type": "request",
"name": "Trigger an SFC Selection event.",
"description": "Sends an SFC selection event to the message broker to be consumed and sent to the Pods subscribing to the selection event. PODs can subscribe to the selection event by enabling Notifications for the SFC Select Event in the POD Designer. The receiving POD User Interface will select the SFC.",
"method": "POST",
"url": "{{ _.base_url }}/sfcselect",
"parentId": "req_631d0b545d894096b8316ea3",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"plant\": \"string\",\n \"sfc\": \"string\"\n}"
}
},
{
"_id": "req_63dde1c7e8ef4826841554cc",
"_type": "request",
"name": "Retrieves SFC details for an SFC.",
"description": "SFC details includes information about the SFC, including the SFC status, material, order, routing, and routing steps. The sfcdetail API returns all operation activity/step IDs from the requested SFC, which can be any status. This endpoint is now deprecated, please use the successor API Get SFC details",
"method": "GET",
"url": "{{ _.base_url }}/sfcdetail",
"parentId": "req_631d0b545d894096b8316ea3",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "The plant in which the SFC is in work.",
"disabled": false
},
{
"name": "sfc",
"value": "",
"description": "The SFC for which the details are requested.",
"disabled": false
},
{
"name": "allRouterVersions",
"value": "",
"description": "By default, set to true. A true value indicates that data for all router versions is retrieved. A false value returns data for only the current router version, and thus can be used to enhance performance in certain cases.",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_2fd1c5bdf0b94b49bdd6ca8d",
"_type": "request",
"name": "Retrieves SFC data based on either the SFC ID or the serial number.",
"description": "Retrieves information about the status, bill of materials (BOM), quantity, order, material, routing, and routing steps of a specific SFC. It returns the IDs of all operation activities/steps associated with the requested SFC, regardless of their status. To get the information of an SFC, you must provide either the SFC ID or the serial number.",
"method": "GET",
"url": "{{ _.base_url }}/sfcData",
"parentId": "req_631d0b545d894096b8316ea3",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "Specify the plant where the SFC is currently being processed.",
"disabled": false
},
{
"name": "sfc",
"value": "",
"description": "Specify the SFC for which the user requests details.",
"disabled": true
},
{
"name": "serialNumber",
"value": "",
"description": "Specify the serial number of the SFC for which the user requests details.",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_70e8b584480f494392ebab9b",
"_type": "request",
"name": "Invalidate an SFC in a specific plant.",
"description": "This enables the invalidate of a specific SFC at a designated plant. You can only invalidate an SFC if it is in one of the statuses: New, In-Queue, or Hold.",
"method": "PATCH",
"url": "{{ _.base_url }}/sfcs/invalidate",
"parentId": "req_631d0b545d894096b8316ea3",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "Provide the specific plant for invalidating the SFC.",
"disabled": false
},
{
"name": "sfc",
"value": "",
"description": "Name of the SFC to be invalidated.",
"disabled": false
}
],
"authentication": {}
},
{
"_id": "req_1bf0954d6cac40e1b93eaa4e",
"_type": "request",
"name": "Get SFCs at Resource.",
"description": "Retrieves all the SFCs that are in work at a given resource. A resource may have the capacity of working on one or many SFCs at the same time. SFCs on a relaxed flow router are not retrieved.",
"method": "GET",
"url": "{{ _.base_url }}/sfcsInWork",
"parentId": "req_631d0b545d894096b8316ea3",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "The plant where the resource is.",
"disabled": false
},
{
"name": "page.offset",
"value": "",
"description": "The offset that determines the first item to be returned in the first page (skip).",
"disabled": true
},
{
"name": "page.size",
"value": "",
"description": "The number of items to return in each page (top).",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_8ee489466c094ce2a5c943be",
"_type": "request",
"name": "Signoff one or more SFCs at an operation activity and resource.",
"description": "The SFCs in Active state are moved back in queue at the same operation activity",
"method": "POST",
"url": "{{ _.base_url }}/sfcs/signoff",
"parentId": "req_631d0b545d894096b8316ea3",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "async",
"value": "",
"description": "Provide a Boolean value for the request to be processed asynchronously.",
"disabled": true
}
],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"plant\": \"string\"\n}"
}
},
{
"_id": "req_d3b9f89cb0464a0e9fffdbd3",
"_type": "request",
"name": "Update SFC default batch ID.",
"description": "Update SFC default batch ID with a given batch ID. The given batch ID is checked for validity against valid batch IDs based on the SFC material.",
"method": "PUT",
"url": "{{ _.base_url }}/batch",
"parentId": "req_631d0b545d894096b8316ea3",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"batchNumber\": \"string\",\n \"plant\": \"string\",\n \"sfc\": \"string\"\n}"
}
},
{
"_id": "req_8c9723bef9ca4f8983ed6ca2",
"_type": "request",
"name": "Retrieves the number of SFCs in the work list.",
"description": "Return the number of SFCs in the work list for the given plant and other optional filter criteria. This endpoint is now deprecated, please use the 'totalElements' field from the successor API Get SFC Worklist",
"method": "GET",
"url": "{{ _.base_url }}/worklist/sfcs/$count",
"parentId": "req_631d0b545d894096b8316ea3",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "allSfcSteps",
"value": "",
"description": "By default set to false. A true value is required if quantity decoupled process industry SFCs need to be counted.",
"disabled": true
},
{
"name": "filter.material",
"value": "",
"description": "The material name filter.",
"disabled": true
},
{
"name": "filter.materialRevision",
"value": "",
"description": "The material revision filter.",
"disabled": true
},
{
"name": "filter.operation",
"value": "",
"description": "The operation name filter where an sfc is in queue, inwork, or completePending.",
"disabled": true
},
{
"name": "filter.order",
"value": "",
"description": "The Order filter.",
"disabled": true
},
{
"name": "filter.orderPlannedEndDateTime",
"value": "",
"description": "Filters for orders planned before the order planned end date time.",
"disabled": true
},
{
"name": "filter.orderPlannedStartDateTime",
"value": "",
"description": "Filters for orders planned after the order planned start date time.",
"disabled": true
},
{
"name": "filter.sfc",
"value": "",
"description": "The sfc filter.",
"disabled": true
},
{
"name": "filter.stepId",
"value": "",
"description": "The step ID filter where an sfc is in queue, inwork, or completePending.",
"disabled": true
},
{
"name": "operation",
"value": "",
"description": "The operation we are interested in, ignored if user or work center is specified.",
"disabled": true
},
{
"name": "plant",
"value": "",
"description": "The plant.",
"disabled": false
},
{
"name": "resource",
"value": "",
"description": "The resource at a given operation, if operation specified. If not, will be treated as the scheduled resource.",
"disabled": true
},
{
"name": "user",
"value": "",
"description": "Uses the list of work centers assigned to the indicated user. The list is limited to the work centers assigned to the user in the Manage Users app.",
"disabled": true
},
{
"name": "workCenter",
"value": "",
"description": "An individual work center. This value is ignored if you specify a user.",
"disabled": true
},
{
"name": "sfcStatuses",
"value": "",
"description": "List of SFC statuses that are used to filter the result set.",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_e50293ffe54f4f5fae7e6dcf",
"_type": "request",
"name": "Retrieves an SFC-centric work list including the routing steps.",
"description": "Returns the SFC-centric work list including the routing steps for the given plant and other optional filter criteria. This endpoint is now deprecated, please use the successor API Get SFC Worklist",
"method": "GET",
"url": "{{ _.base_url }}/worklist/sfcs",
"parentId": "req_631d0b545d894096b8316ea3",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "allSfcSteps",
"value": "",
"description": "By default set to false. A true value indicates that all steps within the SFCs should be retrieved. A true value is required if quantity decoupled process industry SFCs need to be retrieved.",
"disabled": true
},
{
"name": "filter.material",
"value": "",
"description": "The material name filter.",
"disabled": true
},
{
"name": "filter.materialRevision",
"value": "",
"description": "The material version filter.",
"disabled": true
},
{
"name": "filter.operation",
"value": "",
"description": "The operation name filter where an SFC is in queue, in work, or pending complete.",
"disabled": true
},
{
"name": "filter.order",
"value": "",
"description": "The Order filter.",
"disabled": true
},
{
"name": "filter.orderPlannedEndDateTime",
"value": "",
"description": "Filters for orders planned before the order planned end date time.",
"disabled": true
},
{
"name": "filter.orderPlannedStartDateTime",
"value": "",
"description": "Filters for orders planned after the order planned start date time.",
"disabled": true
},
{
"name": "filter.sfc",
"value": "",
"description": "The SFC filter.",
"disabled": true
},
{
"name": "filter.stepId",
"value": "",
"description": "The step ID filter where an SFC is in queue, in work, or pending complete.",
"disabled": true
},
{
"name": "operation",
"value": "",
"description": "The operation we are interested in, ignored if user or work center is specified.",
"disabled": true
},
{
"name": "page.offset",
"value": "",
"description": "The offset that determines the first item to be returned in the first page (skip).",
"disabled": true
},
{
"name": "page.size",
"value": "",
"description": "The number of items to return in each page (top).",
"disabled": true
},
{
"name": "plant",
"value": "",
"description": "The plant.",
"disabled": false
},
{
"name": "resource",
"value": "",
"description": "The resource at a given operation, if operation specified. If not, will be treated as the scheduled resource.",
"disabled": true
},
{
"name": "user",
"value": "",
"description": "Uses the list of work centers assigned to the indicated user. The list is limited to the work centers assigned to the user in the Manage Users app.",
"disabled": true
},
{
"name": "workCenter",
"value": "",
"description": "An individual work center. This value is ignored if you specify a user.",
"disabled": true
},
{
"name": "sfcStatuses",
"value": "",
"description": "List of SFC statuses that are used to filter the result set.",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_a0a6c1c570964becbd95ebfe",
"_type": "request",
"name": "Retrieves an Order-centric work list count.",
"description": "Returns the number of orders in the Order-centric work list for the given plant and other optional filter criteria. This endpoint is now deprecated, please use the 'totalElements' field from the successor API Get Worklist Orders",
"method": "GET",
"url": "{{ _.base_url }}/worklist/orders/$count",
"parentId": "req_631d0b545d894096b8316ea3",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "allSfcSteps",
"value": "",
"description": "By default set to false. A true value is required if quantity decoupled process industry orders need to be counted.",
"disabled": true
},
{
"name": "filter.material",
"value": "",
"description": "The material name filter.",
"disabled": true
},
{
"name": "filter.materialRevision",
"value": "",
"description": "The material revision filter.",
"disabled": true
},
{
"name": "filter.operation",
"value": "",
"description": "The operation name filter where an SFC is in a status of in queue, in work, or complete pending.",
"disabled": true
},
{
"name": "filter.order",
"value": "",
"description": "The order filter.",
"disabled": true
},
{
"name": "filter.orderPlannedEndDateTime",
"value": "",
"description": "Filters for orders planned before the order planned end date time.",
"disabled": true
},
{
"name": "filter.orderPlannedStartDateTime",
"value": "",
"description": "Filters for orders planned after the order planned start date time.",
"disabled": true
},
{
"name": "filter.sfc",
"value": "",
"description": "The SFC filter.",
"disabled": true
},
{
"name": "filter.stepId",
"value": "",
"description": "The step ID filter where an SFC is in a status of in queue, in work, or complete pending.",
"disabled": true
},
{
"name": "operation",
"value": "",
"description": "The operation, ignored if user or work center is specified.",
"disabled": true
},
{
"name": "plant",
"value": "",
"description": "The plant.",
"disabled": false
},
{
"name": "resource",
"value": "",
"description": "The resource at a given operation, if operation is specified. If not, the resource will be treated as the scheduled resource.",
"disabled": true
},
{
"name": "user",
"value": "",
"description": "The user.",
"disabled": true
},
{
"name": "workCenter",
"value": "",
"description": "The work center, ignored if user is specified.",
"disabled": true
},
{
"name": "sfcStatuses",
"value": "",
"description": "List of SFC statuses that are used to filter the result set.",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_793b57ad01d2435ab62479b3",
"_type": "request",
"name": "Retrieves an Order-centric work list including SFCs.",
"description": "Returns the Order-centric work list along with a list of SFCs and the routing steps for the given plant and other optional filter criteria. This endpoint is now deprecated, please use the successor API Get Worklist Orders",
"method": "GET",
"url": "{{ _.base_url }}/worklist/orders",
"parentId": "req_631d0b545d894096b8316ea3",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "allSfcSteps",
"value": "",
"description": "By default set to false. A true value indicates that all steps within the SFCs of the order should be retrieved. A true value is required if quantity decoupled process industry orders need to be retrieved.",
"disabled": true
},
{
"name": "filter.material",
"value": "",
"description": "The material name filter.",
"disabled": true
},
{
"name": "filter.materialRevision",
"value": "",
"description": "The material revision filter.",
"disabled": true
},
{
"name": "filter.operation",
"value": "",
"description": "The operation name filter where an SFC is in a status of in queue, in work, or complete pending.",
"disabled": true
},
{
"name": "filter.order",
"value": "",
"description": "The order filter.",
"disabled": true
},
{
"name": "filter.orderPlannedEndDateTime",
"value": "",
"description": "Filters for orders planned before the order planned end date time.",
"disabled": true
},
{
"name": "filter.orderPlannedStartDateTime",
"value": "",
"description": "Filters for orders planned after the order planned start date time.",
"disabled": true
},
{
"name": "filter.sfc",
"value": "",
"description": "The SFC filter.",
"disabled": true
},
{
"name": "filter.stepId",
"value": "",
"description": "The step ID filter where an SFC is in a status of in queue, in work, or complete pending.",
"disabled": true
},
{
"name": "operation",
"value": "",
"description": "The operation, ignored if user or work center is specified.",
"disabled": true
},
{
"name": "page.offset",
"value": "",
"description": "The offset that determines the first item to be returned in the first page (skip).",
"disabled": true
},
{
"name": "page.size",
"value": "",
"description": "The number of items to return in each page (top).",
"disabled": true
},
{
"name": "plant",
"value": "",
"description": "The plant.",
"disabled": false
},
{
"name": "resource",
"value": "",
"description": "The resource at a given operation, if operation is specified. If not, the resource will be treated as the scheduled resource.",
"disabled": true
},
{
"name": "user",
"value": "",
"description": "The user.",
"disabled": true
},
{
"name": "workCenter",
"value": "",
"description": "The work center, ignored if user is specified.",
"disabled": true
},
{
"name": "includeSfcDetails",
"value": "",
"description": "By default set to true. A true value indicates sfc data within the order should be retrieved. A false value indicates sfc data within the order should be ignored in the response.",
"disabled": true
},
{
"name": "sfcStatuses",
"value": "",
"description": "List of SFC statuses that are used to filter the result set.",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_18a3eefaae1b478290d5b705",
"_type": "request",
"name": "Update Alternate Resource Mapping for an SFC/Charge and Operation Activity.",
"description": "Update Alternate Resource Mapping for an SFC and Operation Activity.Change to alternate resource mapping for an SFC and Phase.",
"method": "PUT",
"url": "{{ _.base_url }}/alternateResource",
"parentId": "req_631d0b545d894096b8316ea3",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "The plant.",
"disabled": true
}
],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"operationActivity\": \"string\",\n \"resource\": \"string\",\n \"sfc\": \"string\",\n \"workCenter\": \"string\"\n}"
}
},
{
"_id": "req_a2667a3de5c54ef889a6e021",
"_type": "request",
"name": "Get SFC step activity details.",
"description": "Returns step details for each routing step that the SFC has been started or completed.",
"method": "GET",
"url": "{{ _.base_url }}/stepActivity",
"parentId": "req_631d0b545d894096b8316ea3",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "The plant in which the SFC is processed.",
"disabled": false
},
{
"name": "sfc",
"value": "",
"description": "The shop floor control identifier.",
"disabled": false
}
],
"authentication": {}
},
{
"_id": "req_5fc939c70bd04b408086f83c",
"_type": "request",
"name": "Place a hold on one or more SFCs.",
"description": " Initiate a hold request to temporarily pause the activity of an SFC in a given plant.",
"method": "POST",
"url": "{{ _.base_url }}/sfcs/hold",
"parentId": "req_631d0b545d894096b8316ea3",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"plant\": \"string\",\n \"sfcs\": [\n \"string\"\n ]\n}"
}
},
{
"_id": "req_899e906bdf704391951a9eea",
"_type": "request",
"name": "Release the hold from one or more SFCs .",
"description": " Initiate a release request to remove the hold status of an SFC in a given plant.",
"method": "POST",
"url": "{{ _.base_url }}/sfcs/release",
"parentId": "req_631d0b545d894096b8316ea3",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"plant\": \"string\",\n \"sfcs\": [\n \"string\"\n ]\n}"
}
},
{
"_id": "req_ecc34b7ce3764c45a54c9b49",
"_type": "request_group",
"name": "Shop Floor Control Production Activities",
"description": "Fetch data about shop floor control (SFC) production activities",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_86c71a4d46814870b8d128eb",
"_type": "request",
"name": "Retrieves SFC details for an SFC.",
"description": "SFC details includes information about the SFC, including the SFC status, material, order, and current routing.",
"method": "GET",
"url": "{{ _.base_url }}/sfcdetail",
"parentId": "req_ecc34b7ce3764c45a54c9b49",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "The plant in which the SFC is in work.",
"disabled": false
},
{
"name": "sfc",
"value": "",
"description": "The SFC for which the details are requested.",
"disabled": false
},
{
"name": "includeSfcSteps",
"value": "",
"description": "By default, set to false. A false value will not return any step information for the SFC. A true value provides data with all the steps.",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_73514123817d4e6198de77b2",
"_type": "request",
"name": "Retrieves an SFC-centric work list.",
"description": "Returns an SFC-centric work list for the given plant and other optional filter criteria.",
"method": "GET",
"url": "{{ _.base_url }}/worklist/sfcs",
"parentId": "req_ecc34b7ce3764c45a54c9b49",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "material",
"value": "",
"description": "The material name filter.",
"disabled": true
},
{
"name": "materialRevision",
"value": "",
"description": "The material version filter. Can be used only if material filter is also provided.",
"disabled": true
},
{
"name": "operation",
"value": "",
"description": "The operation name filter where an SFC is in queue, in work, or pending complete.",
"disabled": true
},
{
"name": "orders",
"value": "",
"description": "The Orders filter. Can accept up to 5 orders separated by a comma.",
"disabled": true
},
{
"name": "orderPlannedEndDateTime",
"value": "",
"description": "Filters for orders planned before the order planned end date time.",
"disabled": true
},
{
"name": "orderPlannedStartDateTime",
"value": "",
"description": "Filters for orders planned after the order planned start date time.",
"disabled": true
},
{
"name": "sfcs",
"value": "",
"description": "The SFCs filter. Can accept up to 5 SFCs separated by a comma.",
"disabled": true
},
{
"name": "page",
"value": "",
"description": "Page index (starts from 0), default is 0.",
"disabled": true
},
{
"name": "size",
"value": "",
"description": "The number of items to return in each page (top). Maximum value is 500.",
"disabled": true
},
{
"name": "plant",
"value": "",
"description": "The plant.",
"disabled": false
},
{
"name": "resources",
"value": "",
"description": "The resource at a given operation, if operation specified. If not, will be treated as the scheduled resource. Can accept up to 5 resources separated by a comma.",
"disabled": true
},
{
"name": "workCenters",
"value": "",
"description": "An individual work center. This value is ignored if you specify a user. Can accept up to 5 work centers separated by a comma.",
"disabled": true
},
{
"name": "sfcStatuses",
"value": "",
"description": "List of SFC statuses that are used to filter the result set.",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_26320c25e55a446cafe5af29",
"_type": "request",
"name": "Retrieves an Order-centric work list including SFCs.",
"description": "Returns an Order-centric work list along with a list of SFCs for the given plant and other optional filter criteria.",
"method": "GET",
"url": "{{ _.base_url }}/worklist/orders",
"parentId": "req_ecc34b7ce3764c45a54c9b49",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "material",
"value": "",
"description": "The material name filter.",
"disabled": true
},
{
"name": "materialRevision",
"value": "",
"description": "The material revision filter. Can be used only if material filter is also provided.",
"disabled": true
},
{
"name": "operation",
"value": "",
"description": "The operation name filter where an SFC is in a status of in queue, in work, or complete pending.",
"disabled": true
},
{
"name": "orders",
"value": "",
"description": "The orders filter. Can accept up to 5 orders separated by a comma.",
"disabled": true
},
{
"name": "orderPlannedEndDateTime",
"value": "",
"description": "Filters for orders planned before the order planned end date time.",
"disabled": true
},
{
"name": "orderPlannedStartDateTime",
"value": "",
"description": "Filters for orders planned after the order planned start date time.",
"disabled": true
},
{
"name": "sfcs",
"value": "",
"description": "The SFCs filter. Can accept up to 5 SFCs separated by a comma.",
"disabled": true
},
{
"name": "page",
"value": "",
"description": "Page index (starts from 0), default is 0.",
"disabled": true
},
{
"name": "size",
"value": "",
"description": "The number of items to return in each page (top). Maximum value is 500.",
"disabled": true
},
{
"name": "plant",
"value": "",
"description": "The plant.",
"disabled": false
},
{
"name": "resources",
"value": "",
"description": "The resource at a given operation, if operation is specified. If not, the resource will be treated as the scheduled resource. Can accept up to 5 resources separated by a comma.",
"disabled": true
},
{
"name": "workCenters",
"value": "",
"description": "The work center, ignored if user is specified. Can accept up to 5 work centers separated by a comma.",
"disabled": true
},
{
"name": "includeSfcDetails",
"value": "",
"description": "By default set to false. A true value indicates SFC data within the order should be retrieved. A false value indicates SFC data within the order should be ignored in the response.",
"disabled": true
},
{
"name": "sfcStatuses",
"value": "",
"description": "List of SFC statuses that are used to filter the result set.",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_3950e7a5514344d4b5e4f421",
"_type": "request_group",
"name": "Standard Rates",
"description": "Get a list of standard rates by resource or workcenter.",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_f3f2e3718b7343e09b249280",
"_type": "request",
"name": "Standard Rates by Resource or Workcenter.",
"description": "Retrieves Standard Rates for a given plant based on a Resource or Workcenter.",
"method": "GET",
"url": "{{ _.base_url }}/v1/standardRatesByResourceOrWorkCenter",
"parentId": "req_3950e7a5514344d4b5e4f421",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "Plant provided as the input parameter.",
"disabled": false
},
{
"name": "resource",
"value": "",
"description": "Resource provided as the input parameter.",
"disabled": true
},
{
"name": "workcenter",
"value": "",
"description": "Workcenter provided as the input parameter.",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_5c45441b629f468b8d3ff6f8",
"_type": "request",
"name": "Creates standard rates.",
"description": "Creates standard rates provided in the request.",
"method": "POST",
"url": "{{ _.base_url }}/v1/standardRates",
"parentId": "req_3950e7a5514344d4b5e4f421",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"plant\": \"string\",\n \"quantity\": 0.0,\n \"time\": 0.0,\n \"timeUnitsType\": \"string\"\n}"
}
},
{
"_id": "req_136205004edc457daea14dd5",
"_type": "request",
"name": "Updates standard rate.",
"description": "The request to update the standard rate.",
"method": "PATCH",
"url": "{{ _.base_url }}/v1/standardRates",
"parentId": "req_3950e7a5514344d4b5e4f421",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"keyId\": \"string\",\n \"modifiedDateTime\": \"2024-01-01T00:00:00Z\",\n \"plant\": \"string\"\n}"
}
},
{
"_id": "req_e1a61a3456744ac79ac392ec",
"_type": "request",
"name": "Deletes standard rates.",
"description": "The request to delete the standard rate.",
"method": "DELETE",
"url": "{{ _.base_url }}/v1/standardRates",
"parentId": "req_3950e7a5514344d4b5e4f421",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {}
},
{
"_id": "req_6c61a07258a941e084ce1244",
"_type": "request_group",
"name": "Standard Values",
"description": "Retrieves standard values",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_6b5e394550a845afb04e3af4",
"_type": "request",
"name": "Retrieves Standard Values",
"description": "Retrieves standard values for recipes or routing associated with operation activities.",
"method": "GET",
"url": "{{ _.base_url }}/details",
"parentId": "req_6c61a07258a941e084ce1244",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "Plant from where the standard values have to be retrieved.",
"disabled": false
},
{
"name": "workCenter",
"value": "",
"description": "Work center from where the standard values have to be retrieved.",
"disabled": false
},
{
"name": "operationActivity",
"value": "",
"description": "Operation or phase for which the standard values have to be retrieved.",
"disabled": false
},
{
"name": "operationActivityVersion",
"value": "",
"description": "Operation or phase for which the standard values have to be retrieved.",
"disabled": false
},
{
"name": "object",
"value": "",
"description": "Routing or recipe for which the standard values have to be retrieved.",
"disabled": false
},
{
"name": "objectType",
"value": "",
"description": "Type of the routing or recipe. \nPossible values: \nPRODUCTION - Master Recipe; \nSHOP_ORDER - Shop Order-specific Recipe; \n SHOPORDER_SPECIFIC_RECIPE - Shop Order-specific Recipe; \nPRODUCTION_ROUTING - Production Routing; \nSHOP_ORDER_ROUTING - Shop Order-specific Routing",
"disabled": false
},
{
"name": "objectVersion",
"value": "",
"description": "Version of the routing or recipe.",
"disabled": false
},
{
"name": "stepId",
"value": "",
"description": "StepId of the routing or recipe.",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_58fbef748a4848d0bc3f81bb",
"_type": "request_group",
"name": "Time Tracking",
"description": "Manage time tracking records and events for activities on the shop floor.",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_284f2c789b6646d190438f34",
"_type": "request",
"name": "Create a time record for attendance.",
"description": "Create a time record for a user to record attendance.",
"method": "POST",
"url": "{{ _.base_url }}/v1/attendance",
"parentId": "req_58fbef748a4848d0bc3f81bb",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"plant\": \"string\",\n \"startTime\": \"2024-01-01T00:00:00Z\",\n \"userId\": \"string\"\n}"
}
},
{
"_id": "req_750e5da056144fca83159038",
"_type": "request",
"name": "Create a start event for attendance.",
"description": "Create a start event for attendance to clock in a user.",
"method": "POST",
"url": "{{ _.base_url }}/v1/attendance/start",
"parentId": "req_58fbef748a4848d0bc3f81bb",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"plant\": \"string\",\n \"userId\": \"string\"\n}"
}
},
{
"_id": "req_cfb8baad7bfd45e58f0875c8",
"_type": "request",
"name": "Create a stop event for attendance.",
"description": "Create a stop event for attendance to clock out a user.",
"method": "POST",
"url": "{{ _.base_url }}/v1/attendance/stop",
"parentId": "req_58fbef748a4848d0bc3f81bb",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"plant\": \"string\",\n \"userId\": \"string\"\n}"
}
},
{
"_id": "req_c2fa243f192d44ddbba90a0a",
"_type": "request",
"name": "Update a time record for attendance.",
"description": "Update a defined time record for attendance for a user.",
"method": "PATCH",
"url": "{{ _.base_url }}/v1/attendance/{id}",
"parentId": "req_58fbef748a4848d0bc3f81bb",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"startTime\": \"2024-01-01T00:00:00Z\"\n}"
}
},
{
"_id": "req_28e0c49c1bfe4e20a7a5d200",
"_type": "request",
"name": "Create a time record for direct labor.",
"description": "Create a time record to track direct labor for a user working on an SFC.",
"method": "POST",
"url": "{{ _.base_url }}/v1/direct-labor",
"parentId": "req_58fbef748a4848d0bc3f81bb",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"operation\": \"string\",\n \"plant\": \"string\",\n \"resource\": \"string\",\n \"routing\": \"string\",\n \"routingType\": \"string\",\n \"routingVersion\": \"string\",\n \"sfc\": \"string\",\n \"shopOrder\": \"string\",\n \"startTime\": \"2024-01-01T00:00:00Z\",\n \"stepId\": \"string\",\n \"userId\": \"string\",\n \"workCenter\": \"string\"\n}"
}
},
{
"_id": "req_197303d1b4da4c3ca17d01b5",
"_type": "request",
"name": "Create a start event for direct labor for a process lot.",
"description": "Create a start event to start labor tracking for a user working on a process lot.",
"method": "POST",
"url": "{{ _.base_url }}/v1/direct-labor/processlot/start",
"parentId": "req_58fbef748a4848d0bc3f81bb",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"operation\": \"string\",\n \"plant\": \"string\",\n \"processLot\": \"string\",\n \"resource\": \"string\",\n \"routing\": \"string\",\n \"routingType\": \"string\",\n \"routingVersion\": \"string\",\n \"stepId\": \"string\",\n \"userId\": \"string\",\n \"workCenter\": \"string\"\n}"
}
},
{
"_id": "req_2851807199134217af08b19b",
"_type": "request",
"name": "Create a stop event for direct labor for a process lot.",
"description": "Create a stop event to stop labor tracking for a user working on a process lot.",
"method": "POST",
"url": "{{ _.base_url }}/v1/direct-labor/processlot/stop",
"parentId": "req_58fbef748a4848d0bc3f81bb",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"operation\": \"string\",\n \"plant\": \"string\",\n \"processLot\": \"string\",\n \"resource\": \"string\",\n \"routing\": \"string\",\n \"routingType\": \"string\",\n \"routingVersion\": \"string\",\n \"stepId\": \"string\",\n \"userId\": \"string\",\n \"workCenter\": \"string\"\n}"
}
},
{
"_id": "req_8184536fbf1d442aabf496c4",
"_type": "request",
"name": "Create a start event for direct labor for an SFC.",
"description": "Create a start event to start labor tracking for a user working on an SFC.",
"method": "POST",
"url": "{{ _.base_url }}/v1/direct-labor/start",
"parentId": "req_58fbef748a4848d0bc3f81bb",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"operation\": \"string\",\n \"plant\": \"string\",\n \"resource\": \"string\",\n \"routing\": \"string\",\n \"routingType\": \"string\",\n \"routingVersion\": \"string\",\n \"sfc\": \"string\",\n \"shopOrder\": \"string\",\n \"stepId\": \"string\",\n \"userId\": \"string\",\n \"workCenter\": \"string\"\n}"
}
},
{
"_id": "req_31fb3cdc16204844b13a4057",
"_type": "request",
"name": "Create a stop event for direct labor for an SFC.",
"description": "Create a stop event to stop labor tracking for a user working on an SFC.",
"method": "POST",
"url": "{{ _.base_url }}/v1/direct-labor/stop",
"parentId": "req_58fbef748a4848d0bc3f81bb",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"operation\": \"string\",\n \"plant\": \"string\",\n \"resource\": \"string\",\n \"routing\": \"string\",\n \"routingType\": \"string\",\n \"routingVersion\": \"string\",\n \"sfc\": \"string\",\n \"shopOrder\": \"string\",\n \"stepId\": \"string\",\n \"userId\": \"string\",\n \"workCenter\": \"string\"\n}"
}
},
{
"_id": "req_35a23678de634e76965529e6",
"_type": "request",
"name": "Update a time record for direct labor.",
"description": "Update a defined time record for direct labor for a user.",
"method": "PATCH",
"url": "{{ _.base_url }}/v1/direct-labor/{id}",
"parentId": "req_58fbef748a4848d0bc3f81bb",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"startTime\": \"2024-01-01T00:00:00Z\"\n}"
}
},
{
"_id": "req_20892908e5564c0891c202e3",
"_type": "request",
"name": "Create a time record for indirect labor.",
"description": "Create a time record to track indirect labor for a user.",
"method": "POST",
"url": "{{ _.base_url }}/v1/indirect-labor",
"parentId": "req_58fbef748a4848d0bc3f81bb",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"activity\": \"string\",\n \"plant\": \"string\",\n \"startTime\": \"2024-01-01T00:00:00Z\",\n \"userId\": \"string\"\n}"
}
},
{
"_id": "req_6dca0c408c1d46ba90c5a001",
"_type": "request",
"name": "Create a start event for indirect labor.",
"description": "Create an event for indirect labor to start tracking an indirect labor activity for users on the shop floor.",
"method": "POST",
"url": "{{ _.base_url }}/v1/indirect-labor/start",
"parentId": "req_58fbef748a4848d0bc3f81bb",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"plant\": \"string\",\n \"userId\": \"string\"\n}"
}
},
{
"_id": "req_c6e31705e8d6489daf10db65",
"_type": "request",
"name": "Create a stop event for indirect labor.",
"description": "Create an event for indirect labor to stop tracking an indirect labor activity for users on the shop floor.",
"method": "POST",
"url": "{{ _.base_url }}/v1/indirect-labor/stop",
"parentId": "req_58fbef748a4848d0bc3f81bb",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"plant\": \"string\",\n \"userId\": \"string\"\n}"
}
},
{
"_id": "req_b25daae63c6c408ca42a9658",
"_type": "request",
"name": "Update a time record for indirect labor.",
"description": "Update a defined time record for indirect labor for a user.",
"method": "PATCH",
"url": "{{ _.base_url }}/v1/indirect-labor/{id}",
"parentId": "req_58fbef748a4848d0bc3f81bb",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"activity\": \"string\",\n \"startTime\": \"2024-01-01T00:00:00Z\"\n}"
}
},
{
"_id": "req_00aa75a685ca4c66926e72be",
"_type": "request",
"name": "Create a time record for production time.",
"description": "Create a time record to record the production time of an SFC.",
"method": "POST",
"url": "{{ _.base_url }}/v1/production-time",
"parentId": "req_58fbef748a4848d0bc3f81bb",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"operation\": \"string\",\n \"operationVersion\": \"string\",\n \"plant\": \"string\",\n \"resource\": \"string\",\n \"routing\": \"string\",\n \"routingType\": \"string\",\n \"routingVersion\": \"string\",\n \"sfc\": \"string\",\n \"shopOrder\": \"string\",\n \"startTime\": \"2024-01-01T00:00:00Z\",\n \"stepId\": \"string\",\n \"userId\": \"string\",\n \"workCenter\": \"string\"\n}"
}
},
{
"_id": "req_478b2913c9804eacad614819",
"_type": "request",
"name": "Create a start event for the production time of a process lot.",
"description": "Create a start event for a time record to record the production time of a process lot.",
"method": "POST",
"url": "{{ _.base_url }}/v1/production-time/processlot/start",
"parentId": "req_58fbef748a4848d0bc3f81bb",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"operation\": \"string\",\n \"operationVersion\": \"string\",\n \"plant\": \"string\",\n \"processLot\": \"string\",\n \"resource\": \"string\",\n \"routing\": \"string\",\n \"routingType\": \"string\",\n \"routingVersion\": \"string\",\n \"stepId\": \"string\",\n \"userId\": \"string\",\n \"workCenter\": \"string\"\n}"
}
},
{
"_id": "req_51985b866ef1407f9e4fc14a",
"_type": "request",
"name": "Create a stop event for the production time of a process lot.",
"description": "Create a stop event for a time record that records the production time of a process lot.",
"method": "POST",
"url": "{{ _.base_url }}/v1/production-time/processlot/stop",
"parentId": "req_58fbef748a4848d0bc3f81bb",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"operation\": \"string\",\n \"operationVersion\": \"string\",\n \"plant\": \"string\",\n \"processLot\": \"string\",\n \"resource\": \"string\",\n \"routing\": \"string\",\n \"routingType\": \"string\",\n \"routingVersion\": \"string\",\n \"stepId\": \"string\",\n \"userId\": \"string\",\n \"workCenter\": \"string\"\n}"
}
},
{
"_id": "req_6d8c0120dbad4ad183a9daa9",
"_type": "request",
"name": "Create a start event for production time.",
"description": "Create a start event for a time record for production time of an SFC.",
"method": "POST",
"url": "{{ _.base_url }}/v1/production-time/start",
"parentId": "req_58fbef748a4848d0bc3f81bb",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"operation\": \"string\",\n \"operationVersion\": \"string\",\n \"plant\": \"string\",\n \"resource\": \"string\",\n \"routing\": \"string\",\n \"routingType\": \"string\",\n \"routingVersion\": \"string\",\n \"sfc\": \"string\",\n \"shopOrder\": \"string\",\n \"stepId\": \"string\",\n \"userId\": \"string\",\n \"workCenter\": \"string\"\n}"
}
},
{
"_id": "req_b1128513a8e946509f0c7ecb",
"_type": "request",
"name": "Create a stop event for production time.",
"description": "Create a stop event for a time record for production time of an SFC.",
"method": "POST",
"url": "{{ _.base_url }}/v1/production-time/stop",
"parentId": "req_58fbef748a4848d0bc3f81bb",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"operation\": \"string\",\n \"operationVersion\": \"string\",\n \"plant\": \"string\",\n \"resource\": \"string\",\n \"routing\": \"string\",\n \"routingType\": \"string\",\n \"routingVersion\": \"string\",\n \"sfc\": \"string\",\n \"shopOrder\": \"string\",\n \"stepId\": \"string\",\n \"userId\": \"string\",\n \"workCenter\": \"string\"\n}"
}
},
{
"_id": "req_1a0acd96d4ae423bb4ed72fd",
"_type": "request",
"name": "Edit a time record for production time.",
"description": "Update a specific time record for the production time of an SFC.",
"method": "PATCH",
"url": "{{ _.base_url }}/v1/production-time/{id}",
"parentId": "req_58fbef748a4848d0bc3f81bb",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"activity\": \"string\",\n \"adjustedDuration\": \"string\",\n \"endTime\": \"2024-01-01T00:00:00Z\",\n \"note\": \"string\",\n \"startTime\": \"2024-01-01T00:00:00Z\",\n \"workCenter\": \"string\"\n}"
}
},
{
"_id": "req_059cc0d41dfa4a248ae80112",
"_type": "request",
"name": "Create a time record for resource usage.",
"description": "Create a time record to record the usage of a resource on the shopfloor.",
"method": "POST",
"url": "{{ _.base_url }}/v1/resource-usage",
"parentId": "req_58fbef748a4848d0bc3f81bb",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"activity\": \"string\",\n \"plant\": \"string\",\n \"resource\": \"string\",\n \"startTime\": \"2024-01-01T00:00:00Z\",\n \"userId\": \"string\",\n \"workCenter\": \"string\"\n}"
}
},
{
"_id": "req_ec88ce5f8dea4542a974fa91",
"_type": "request",
"name": "Create a start event for resource usage.",
"description": "Create a start event for a time record for resource usage on the shopfloor.",
"method": "POST",
"url": "{{ _.base_url }}/v1/resource-usage/start",
"parentId": "req_58fbef748a4848d0bc3f81bb",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"activity\": \"string\",\n \"plant\": \"string\",\n \"resource\": \"string\",\n \"userId\": \"string\"\n}"
}
},
{
"_id": "req_5281eb63a53b4e0dbccaa82b",
"_type": "request",
"name": "Create a stop event for resource usage.",
"description": "Create a stop event for a time record for resource usage on the shopfloor.",
"method": "POST",
"url": "{{ _.base_url }}/v1/resource-usage/stop",
"parentId": "req_58fbef748a4848d0bc3f81bb",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"activity\": \"string\",\n \"plant\": \"string\",\n \"resource\": \"string\",\n \"userId\": \"string\"\n}"
}
},
{
"_id": "req_e5b62766554c4717be5fd4ef",
"_type": "request",
"name": "Update a time record for resource usage.",
"description": "Update a specific time record for resource usage on the shopfloor.",
"method": "PATCH",
"url": "{{ _.base_url }}/v1/resource-usage/{id}",
"parentId": "req_58fbef748a4848d0bc3f81bb",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"activity\": \"string\",\n \"adjustedDuration\": \"string\",\n \"endTime\": \"2024-01-01T00:00:00Z\",\n \"note\": \"string\",\n \"startTime\": \"2024-01-01T00:00:00Z\",\n \"workCenter\": \"string\"\n}"
}
},
{
"_id": "req_5cc96fbf70404e10aae0152a",
"_type": "request",
"name": "Find all time records",
"description": "Find all time records using various filter parameters. (Note: By default the service doesn't return any deleted time records. However, you can use the 'status' parameter to retrieve deleted records.)",
"method": "GET",
"url": "{{ _.base_url }}/v1/time-records",
"parentId": "req_58fbef748a4848d0bc3f81bb",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "The plant of the user tracking the activity type",
"disabled": false
},
{
"name": "type",
"value": "",
"description": "The activity type of the time record",
"disabled": true
},
{
"name": "userId",
"value": "",
"description": "The ID of the user tracking the activity type",
"disabled": true
},
{
"name": "start",
"value": "",
"description": "The start date and time of the event",
"disabled": true
},
{
"name": "end",
"value": "",
"description": "The end date and time of the event",
"disabled": true
},
{
"name": "resource",
"value": "",
"description": "The name of the resource",
"disabled": true
},
{
"name": "workCenter",
"value": "",
"description": "The name of the work center",
"disabled": true
},
{
"name": "operation",
"value": "",
"description": "The name of the operation activity",
"disabled": true
},
{
"name": "operationVersion",
"value": "",
"description": "The version of the operation activity",
"disabled": true
},
{
"name": "stepId",
"value": "",
"description": "The ID of the activity",
"disabled": true
},
{
"name": "shopOrder",
"value": "",
"description": "The number of the order",
"disabled": true
},
{
"name": "sfc",
"value": "",
"description": "The number of the SFC",
"disabled": true
},
{
"name": "status",
"value": "",
"description": "The status of the time record",
"disabled": true
},
{
"name": "routing",
"value": "",
"description": "The name of the routing",
"disabled": true
},
{
"name": "routingVersion",
"value": "",
"description": "The version of the routing",
"disabled": true
},
{
"name": "routingType",
"value": "",
"description": "The type of the routing",
"disabled": true
},
{
"name": "standardValue",
"value": "",
"description": "The standard value against which labor is tracked. (Note: This parameter is ignored if 'activity' parameter is provided.)",
"disabled": true
},
{
"name": "activity",
"value": "",
"description": "The activity recorded for the activity type",
"disabled": true
},
{
"name": "page",
"value": "",
"description": "Zero-based page index (0..N)",
"disabled": true
},
{
"name": "size",
"value": "",
"description": "The size of the page to be returned",
"disabled": true
},
{
"name": "sort",
"value": "",
"description": "Sorting criteria in the format: property,asc/desc. The default sort order is ascending. Multiple sort criteria are supported.",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_a091b8b0dbce4d8d89620173",
"_type": "request",
"name": "Approve time records.",
"description": "Approve a batch of time records.",
"method": "POST",
"url": "{{ _.base_url }}/v1/time-records/approve",
"parentId": "req_58fbef748a4848d0bc3f81bb",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "[\n \"string\"\n]"
}
},
{
"_id": "req_02cf279dcbbb4342821165c0",
"_type": "request",
"name": "Approve a time record.",
"description": "Approve a defined time record for a user.",
"method": "POST",
"url": "{{ _.base_url }}/v1/time-records/approve/{id}",
"parentId": "req_58fbef748a4848d0bc3f81bb",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {}
},
{
"_id": "req_9d94f832eada4ae6b209e9d8",
"_type": "request",
"name": "Find a time record",
"description": "Find a time record by providing its ID.",
"method": "GET",
"url": "{{ _.base_url }}/v1/time-records/{id}",
"parentId": "req_58fbef748a4848d0bc3f81bb",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {}
},
{
"_id": "req_17ade3afdcd64dae954bf704",
"_type": "request",
"name": "Delete a time record.",
"description": "Delete a defined time record for a user.",
"method": "DELETE",
"url": "{{ _.base_url }}/v1/time-records/{id}",
"parentId": "req_58fbef748a4848d0bc3f81bb",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "note",
"value": "",
"description": "A short note or comment about the event",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_cf2d36bee39f49be9e8cf2b0",
"_type": "request_group",
"name": "Time Tracking",
"description": "Manage time tracking records and events for activities on the shop floor.",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_77ba295ec248466790fd6fe1",
"_type": "request",
"name": "Fetch activities of a specific plant.",
"description": "Fetch activities for indirect labor and resource usage for a specific plant.",
"method": "GET",
"url": "{{ _.base_url }}/v1/Activities",
"parentId": "req_cf2d36bee39f49be9e8cf2b0",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "The plant assigned to the activities",
"disabled": false
},
{
"name": "sap-locale",
"value": "",
"description": "The locale on which the language of the activity description is dependent",
"disabled": true
},
{
"name": "$expand",
"value": "",
"description": "The value of $expand query option is a comma-separated list of text objects. Each one has a different locale which implies the description language. The corresponding related entities and stream values will be represented inline, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"disabled": true
},
{
"name": "$orderby",
"value": "",
"description": "Orders items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
"disabled": true
},
{
"name": "$filter",
"value": "",
"description": "Filters items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_3db0794632254170bb0e1d28",
"_type": "request_group",
"name": "Tool",
"description": "Perform production tool related operations such as tool usage logging, tool validation, tool loading and unloading",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_cb0d43d4401b415fa1166b71",
"_type": "request",
"name": "Sets automatic logging of tool usage for SFCs",
"description": "Enables automatic logging of tool usage for SFCs that have already been started and are not yet done. Only tools specified with automatic logging method would be logged.",
"method": "POST",
"url": "{{ _.base_url }}/toolUsageLogs",
"parentId": "req_3db0794632254170bb0e1d28",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"operation\": \"string\",\n \"plant\": \"string\",\n \"resource\": \"string\",\n \"sfcs\": [\n \"string\"\n ]\n}"
}
},
{
"_id": "req_948a885af4094acdae3ccb9f",
"_type": "request",
"name": "Get tool validation result for loaded tools",
"description": "Validate loaded tools by checking the alignment between loaded tools and PRT assignments. \nThere are 2 possible validation results: PRT_PASSED, FAILED.",
"method": "POST",
"url": "{{ _.base_url }}/prtLoadValidation",
"parentId": "req_3db0794632254170bb0e1d28",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"operation\": \"string\",\n \"plant\": \"string\",\n \"resource\": \"string\"\n}"
}
},
{
"_id": "req_3ceb941ccfea4280856ab836",
"_type": "request",
"name": "Gets loaded tools.",
"description": "Retrieves tool numbers of loaded tools for a given plant and location.",
"method": "GET",
"url": "{{ _.base_url }}/loadedTools",
"parentId": "req_3db0794632254170bb0e1d28",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "The plant where the tools are loaded",
"disabled": false
},
{
"name": "location",
"value": "",
"description": "The location of the loaded tools",
"disabled": false
},
{
"name": "locationType",
"value": "",
"description": "The type of the location where the loaded tools are placed",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_1cec430e404a415fb219c709",
"_type": "request",
"name": "Loads a tool.",
"description": "Loads a tool for a given plant and location.",
"method": "POST",
"url": "{{ _.base_url }}/loadTool",
"parentId": "req_3db0794632254170bb0e1d28",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"location\": \"string\",\n \"plant\": \"string\",\n \"toolNumber\": \"string\"\n}"
}
},
{
"_id": "req_2b8fda01f0824e2cb3b49b7d",
"_type": "request",
"name": "Unloads a tool.",
"description": "Unloads a tool for a given plant and location.",
"method": "POST",
"url": "{{ _.base_url }}/unloadTool",
"parentId": "req_3db0794632254170bb0e1d28",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"location\": \"string\",\n \"plant\": \"string\",\n \"toolNumber\": \"string\"\n}"
}
},
{
"_id": "req_b3838e448c8e4fb8942a1846",
"_type": "request",
"name": "Retrieves tool information.",
"description": "Retrieves information of a tool for a given plant.",
"method": "GET",
"url": "{{ _.base_url }}/tools",
"parentId": "req_3db0794632254170bb0e1d28",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "The plant of the tool.",
"disabled": false
},
{
"name": "toolNumber",
"value": "",
"description": "The tool number of the tool.",
"disabled": true
},
{
"name": "prtNumber",
"value": "",
"description": "The production resources/tools (PRT) number of the tool.",
"disabled": true
},
{
"name": "material",
"value": "",
"description": "The material number of the tool.",
"disabled": true
},
{
"name": "materialVersion",
"value": "",
"description": "The material version of the tool.",
"disabled": true
},
{
"name": "toolType",
"value": "",
"description": "The type of the tool.",
"disabled": true
},
{
"name": "loggingMethod",
"value": "",
"description": "The logging method of the tool.",
"disabled": true
},
{
"name": "origin",
"value": "",
"description": "The origin of the tool.",
"disabled": true
},
{
"name": "status",
"value": "",
"description": "The status of the tool.",
"disabled": true
},
{
"name": "page",
"value": "",
"description": "The page number you want to query. Number 0 is the first page. Example: https://xxx?plant=XX&page=0&size=1",
"disabled": true
},
{
"name": "size",
"value": "",
"description": "The page size determines how many records are displayed in one page. Default page size is 20.",
"disabled": true
},
{
"name": "sort",
"value": "",
"description": "The retrieved records can be sorted using one or more of the following fields: 'toolNumber','prtNumber' ,'createdOn'. Example: 'https://xxx?xxxx&sort=toolNumber,desc&sort=createdOn,desc' ",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_dbb5c28ad6214f5f833f726e",
"_type": "request",
"name": "Creates a tool.",
"description": "Creates a tool for a given plant.",
"method": "POST",
"url": "{{ _.base_url }}/tools",
"parentId": "req_3db0794632254170bb0e1d28",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"plant\": \"string\",\n \"prtNumber\": \"string\",\n \"toolType\": \"string\"\n}"
}
},
{
"_id": "req_6ca17ba5594f41a4a5f93237",
"_type": "request",
"name": "Updates a tool.",
"description": "Updates a tool for a given plant and tool number.",
"method": "PUT",
"url": "{{ _.base_url }}/tools",
"parentId": "req_3db0794632254170bb0e1d28",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"plant\": \"string\",\n \"toolNumber\": \"string\"\n}"
}
},
{
"_id": "req_dab2f17217e1435080426066",
"_type": "request",
"name": "Updates tool status.",
"description": "Updates the tool status for a given plant and tools. You can't change the status of a productive tool that is loaded to a resource using this API service. For these tasks, refer to tool loading and tool unloading.",
"method": "POST",
"url": "{{ _.base_url }}/tools/status",
"parentId": "req_3db0794632254170bb0e1d28",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"plant\": \"string\",\n \"status\": \"string\",\n \"toolNumbers\": [\n \"string\"\n ]\n}"
}
},
{
"_id": "req_b8003a2fdd5a4eb88e0cebaf",
"_type": "request",
"name": "Resets a tool.",
"description": "Resets the used count and used time to zero for a given plant and tool.",
"method": "POST",
"url": "{{ _.base_url }}/tools/calibration",
"parentId": "req_3db0794632254170bb0e1d28",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"plant\": \"string\",\n \"toolNumber\": \"string\"\n}"
}
},
{
"_id": "req_f2f966975b214e749d897efc",
"_type": "request",
"name": "Creates a tool usage logging record.",
"description": "Create a tool usage logging record for a given plant and shop floor control (SFC). You can only use this API service to log usage for tools that have a manual logging method.",
"method": "POST",
"url": "{{ _.base_url }}/tools/manualToolUsageLog",
"parentId": "req_3db0794632254170bb0e1d28",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"operation\": \"string\",\n \"plant\": \"string\",\n \"resource\": \"string\",\n \"sfc\": \"string\",\n \"toolNumber\": \"string\"\n}"
}
},
{
"_id": "req_7e17974380dc4dee97e1d65e",
"_type": "request",
"name": "Retrieves production resources/tools (PRT) assignments for an order.",
"description": "Retrieves PRT assignments for a given plant and order. You can retrieve PRT assignments for the entire order, or for a specific operation activity. If there're multiple routings assigned to the order, the system retrieves only PRT assignments of the routing with the current version.",
"method": "GET",
"url": "{{ _.base_url }}/tools/prtAssignment",
"parentId": "req_3db0794632254170bb0e1d28",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "The plant of the order.",
"disabled": false
},
{
"name": "order",
"value": "",
"description": "The order for which the PRT assignment is retrieved.",
"disabled": false
},
{
"name": "stepId",
"value": "",
"description": "The operation activity ID of the order's routing.",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_738054a25533447c87094e08",
"_type": "request",
"name": "Retrieves routings and routing steps.",
"description": "Retrieves routings and routing steps by production resources/tools (PRTs) for a given plant.",
"method": "GET",
"url": "{{ _.base_url }}/tools/{prt}/routings",
"parentId": "req_3db0794632254170bb0e1d28",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "The plant of the PRT.",
"disabled": false
},
{
"name": "startTime",
"value": "",
"description": "If specified, the system retrieves routings by PRT assignments that are created at or after the specified time.",
"disabled": true
},
{
"name": "endTime",
"value": "",
"description": "If specified, the system retrieves routings by PRT assignments that are created up to the specified time.",
"disabled": true
},
{
"name": "page",
"value": "",
"description": "The page number you want to query. Number 0 is the first page.",
"disabled": true
},
{
"name": "size",
"value": "",
"description": "The page size determines how many routing steps are displayed in one page. Default page size is 20.",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_682c46d4706e46e2a70d573d",
"_type": "request_group",
"name": "Tool",
"description": "Perform production tool related operations such as tool usage logging, tool validation, tool loading and unloading",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_d295fb26ed7547028145ab22",
"_type": "request",
"name": "Retrieves tool information.",
"description": "Retrieves information of a tool for a given plant.",
"method": "GET",
"url": "{{ _.base_url }}/tools",
"parentId": "req_682c46d4706e46e2a70d573d",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "The plant of the tool.",
"disabled": false
},
{
"name": "toolNumber",
"value": "",
"description": "The identification number assigned to the tool.",
"disabled": true
},
{
"name": "loadedLocation",
"value": "",
"description": "Specifies the location where the tool is currently loaded.",
"disabled": true
},
{
"name": "prtNumber",
"value": "",
"description": "The production resources/tools (PRT) number of the tool.",
"disabled": true
},
{
"name": "material",
"value": "",
"description": "The material number assigned to the tool.",
"disabled": true
},
{
"name": "materialVersion",
"value": "",
"description": "The version of the material.",
"disabled": true
},
{
"name": "toolType",
"value": "",
"description": "The type of the tool.",
"disabled": true
},
{
"name": "loggingMethod",
"value": "",
"description": "The method used to log the tool, such as MANUAL, AUTOMATIC, or NON_TRACKED.",
"disabled": true
},
{
"name": "origin",
"value": "",
"description": "The origin of the tool.",
"disabled": true
},
{
"name": "status",
"value": "",
"description": "The status of the tool.",
"disabled": true
},
{
"name": "page",
"value": "",
"description": "The page number you want to query. Number 0 is the first page.",
"disabled": true
},
{
"name": "size",
"value": "",
"description": "The page size determines how many records are displayed in one page. Default is 20. Maximum allowed is 100.",
"disabled": true
},
{
"name": "sort",
"value": "",
"description": "Sort by one or more fields: 'toolNumber', 'prtNumber', 'createdAt'. Use format: sort=field,direction. Example: sort=toolNumber,desc&sort=createdAt,asc. Default: toolNumber,asc.",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_aad0b8bfab674c12962d4001",
"_type": "request",
"name": "Retrieves records of usage logs",
"description": "Retrieves records of tool usage based on the specified query parameters.",
"method": "GET",
"url": "{{ _.base_url }}/toolUsageLogs",
"parentId": "req_682c46d4706e46e2a70d573d",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "Plant where the tool usage took place.",
"disabled": false
},
{
"name": "toolNumber",
"value": "",
"description": "Tool number to query.",
"disabled": false
},
{
"name": "sfc",
"value": "",
"description": "Shop Floor Control (SFC) number for which the tool usage is recorded.",
"disabled": true
},
{
"name": "operation",
"value": "",
"description": "Operation against which the tool usage is logged.",
"disabled": true
},
{
"name": "resource",
"value": "",
"description": "Resource where the tool was used.",
"disabled": true
},
{
"name": "page",
"value": "",
"description": "The page number you want to query. Number 0 is the first page.",
"disabled": true
},
{
"name": "size",
"value": "",
"description": "The page size determines how many records are displayed in one page. Default is 20. Maximum allowed is 100.",
"disabled": true
},
{
"name": "sort",
"value": "",
"description": "Sorting of results. Supported column: createdAt. Use the format: sort=field,direction. Example: sort=createdAt,desc.",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_60717e8c73e9466f8113e066",
"_type": "request",
"name": "Get tool validation result for loaded tools",
"description": "Validate loaded tools by checking the alignment between loaded tools and PRT assignments. \nThere are 2 possible validation results: PRT_PASSED, FAILED.",
"method": "POST",
"url": "{{ _.base_url }}/prtLoadValidation",
"parentId": "req_682c46d4706e46e2a70d573d",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"operation\": \"string\",\n \"plant\": \"string\",\n \"resource\": \"string\",\n \"sfcs\": [\n \"string\"\n ]\n}"
}
},
{
"_id": "req_738ec86df888419f9ab3513c",
"_type": "request",
"name": "Retrieves routings and routing steps.",
"description": "Retrieves routings and routing steps by production resources/tools (PRTs) for a given plant.",
"method": "GET",
"url": "{{ _.base_url }}/tools/{prt}/routings",
"parentId": "req_682c46d4706e46e2a70d573d",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "The plant of the PRT.",
"disabled": false
},
{
"name": "startTime",
"value": "",
"description": "If specified, the system retrieves routings by PRT assignments that are created at or after the specified time.",
"disabled": true
},
{
"name": "endTime",
"value": "",
"description": "If specified, the system retrieves routings by PRT assignments that are created up to the specified time.",
"disabled": true
},
{
"name": "page",
"value": "",
"description": "The page number you want to query. Number 0 is the first page.",
"disabled": true
},
{
"name": "size",
"value": "",
"description": "The page size specifies how many routing steps are shown on a single page. The default value is 20, with a minimum of 1 and a maximum of 100.",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_dad67396c8e74f9a811ae679",
"_type": "request",
"name": "Updates tool status.",
"description": "Updates the tool status for a given plant and tools. You can't change the status of a productive tool that is loaded to a resource using this API service. For these tasks, refer to tool loading and tool unloading.",
"method": "POST",
"url": "{{ _.base_url }}/tools/status",
"parentId": "req_682c46d4706e46e2a70d573d",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"plant\": \"string\",\n \"status\": \"string\",\n \"toolNumbers\": [\n \"string\"\n ]\n}"
}
},
{
"_id": "req_f0b77141acfe48148aa8545f",
"_type": "request_group",
"name": "Unit of Measure",
"description": "Browse and modify custom units of measure",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_a6cfc993dbcf4716bcfc0ff6",
"_type": "request",
"name": "Get all dimensions.",
"description": "Finds all dimensions that can be used with custom units of measure.",
"method": "GET",
"url": "{{ _.base_url }}/v1/dimensions",
"parentId": "req_f0b77141acfe48148aa8545f",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {}
},
{
"_id": "req_7874fd4839404146b323dfb9",
"_type": "request",
"name": "Get dimension by name.",
"description": "Provides detailed information about specific dimension by dimension name.",
"method": "GET",
"url": "{{ _.base_url }}/v1/dimensions/{id}",
"parentId": "req_f0b77141acfe48148aa8545f",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {}
},
{
"_id": "req_51457fc4347c453099dad4c9",
"_type": "request",
"name": "Get all units of measure.",
"description": "Retrieves all units of measure available for the tenant including custom ones.",
"method": "GET",
"url": "{{ _.base_url }}/v1/uoms",
"parentId": "req_f0b77141acfe48148aa8545f",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {}
},
{
"_id": "req_c179baffb564434da74f1af4",
"_type": "request",
"name": "Create custom units of measure.",
"description": "Custom units of measure are available for all plants for the tenant.",
"method": "POST",
"url": "{{ _.base_url }}/v1/uoms",
"parentId": "req_f0b77141acfe48148aa8545f",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "[\n {\n \"additiveConstant\": 0,\n \"commercialCodes\": [\n {\n \"commercialCode\": {},\n \"language\": {},\n \"longText\": {},\n \"shortText\": {}\n }\n ],\n \"denominator\": 0,\n \"dimension\": \"string\",\n \"exponentialBase10\": 0,\n \"isPrimary\": true,\n \"isStandard\": true,\n \"isoCode\": \"string\",\n \"numerator\": 0,\n \"unitCode\": \"string\"\n }\n]"
}
},
{
"_id": "req_2752ee849f6a4052971183b4",
"_type": "request",
"name": "Get unit of measure by id.",
"description": "Retrieves unit of measure by unit code.",
"method": "GET",
"url": "{{ _.base_url }}/v1/uoms/{id}",
"parentId": "req_f0b77141acfe48148aa8545f",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {}
},
{
"_id": "req_5ea9ee80332842298c69d31d",
"_type": "request",
"name": "Delete a unit of measure by unit code.",
"description": "Only custom units of measure can be deleted.",
"method": "DELETE",
"url": "{{ _.base_url }}/v1/uoms/{id}",
"parentId": "req_f0b77141acfe48148aa8545f",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {}
},
{
"_id": "req_8d2fe75c43a440c2976218b7",
"_type": "request",
"name": "Get a unit of measure using unitCode.",
"description": "Gets a unit of measure object using its unitCode. Supports the unitCode parameter for special characters.",
"method": "GET",
"url": "{{ _.base_url }}/v2/uoms",
"parentId": "req_f0b77141acfe48148aa8545f",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "unitCode",
"value": "",
"description": "A unit of measure ID for which the request is executed.",
"disabled": false
}
],
"authentication": {}
},
{
"_id": "req_6366e30f7ab144db82a94457",
"_type": "request",
"name": "Delete a unit of measure using unitCode.",
"description": "Only custom units of measure can be deleted. Supports the unitCode parameter for special characters.",
"method": "DELETE",
"url": "{{ _.base_url }}/v2/uoms",
"parentId": "req_f0b77141acfe48148aa8545f",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "unitCode",
"value": "",
"description": "A unit of measure ID for which the request is executed.",
"disabled": false
}
],
"authentication": {}
},
{
"_id": "req_aef46e40d9a14b699596344a",
"_type": "request_group",
"name": "User",
"description": "Manages users to perform operations in a manufacturing process.",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_ac7d9329499b491f89bfab03",
"_type": "request",
"name": "Retrieves a user information.",
"description": "Retrieves a user information by plant and user ID, email or badge number. You need to specify a plant and at least one of the following parameters: user ID, email or badge number.",
"method": "GET",
"url": "{{ _.base_url }}/users",
"parentId": "req_aef46e40d9a14b699596344a",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "The plant where user exists.",
"disabled": false
},
{
"name": "userId",
"value": "",
"description": "The ID of the user to retrieve a user information.",
"disabled": true
},
{
"name": "email",
"value": "",
"description": "The email of the user to retrieve a user information.",
"disabled": true
},
{
"name": "badgeNumber",
"value": "",
"description": "The badge number of the user to retrieve a user information.",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_65d4c88cb89d4d3e98d287ac",
"_type": "request",
"name": "Creates a user.",
"description": "Creates a user by the given request.",
"method": "POST",
"url": "{{ _.base_url }}/users",
"parentId": "req_aef46e40d9a14b699596344a",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"plant\": \"string\",\n \"userId\": \"string\"\n}"
}
},
{
"_id": "req_8b9e89ff63ed49a4a4891be9",
"_type": "request",
"name": "Updates the user.",
"description": "Updates the existing user by the given request.",
"method": "PATCH",
"url": "{{ _.base_url }}/users",
"parentId": "req_aef46e40d9a14b699596344a",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"plant\": \"string\",\n \"userId\": \"string\"\n}"
}
},
{
"_id": "req_e84f0299000e4d9590014556",
"_type": "request",
"name": "Removes the given user.",
"description": "Removes a user for a given plant",
"method": "DELETE",
"url": "{{ _.base_url }}/users",
"parentId": "req_aef46e40d9a14b699596344a",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {}
},
{
"_id": "req_c6f243a5b6a849c5a5e7283d",
"_type": "request",
"name": "Retrieves a user supervisors.",
"description": "Retrieves a list of user supervisors by plant, user ID, or email. You need to specify a plant and at least one of the following parameters: user ID, email.",
"method": "GET",
"url": "{{ _.base_url }}/supervisors",
"parentId": "req_aef46e40d9a14b699596344a",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "The plant where a user exists.",
"disabled": false
},
{
"name": "userId",
"value": "",
"description": "The identifier of the user to retrieve supervisors. Optional parameter to retrieve user supervisors by the userId value.",
"disabled": true
},
{
"name": "email",
"value": "",
"description": "The email of the user to retrieve supervisors. Optional parameter to retrieve user supervisors by email.",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_657a02441c1d476caa201215",
"_type": "request",
"name": "Retrieves a list of custom field definitions for the user.",
"description": "Returns all maintained custom field definitions, for a given plant.",
"method": "GET",
"url": "{{ _.base_url }}/customFieldDefinitions",
"parentId": "req_aef46e40d9a14b699596344a",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "The plant where a custom field definitions are defined.",
"disabled": false
}
],
"authentication": {}
},
{
"_id": "req_1bcede95d8574206a461db86",
"_type": "request",
"name": "Creates a custom field definition for the user.",
"description": "Creates a custom field definition for the user.",
"method": "POST",
"url": "{{ _.base_url }}/customFieldDefinitions",
"parentId": "req_aef46e40d9a14b699596344a",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"fieldName\": \"string\",\n \"plant\": \"string\"\n}"
}
},
{
"_id": "req_85faa3fd77234b1b8b8b3813",
"_type": "request",
"name": "Updates a custom field definition for the user.",
"description": "Updates field label or sequence in the custom field definition for the user.",
"method": "PATCH",
"url": "{{ _.base_url }}/customFieldDefinitions",
"parentId": "req_aef46e40d9a14b699596344a",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"fieldName\": \"string\",\n \"modifiedDateTime\": \"2024-01-01T00:00:00Z\",\n \"plant\": \"string\"\n}"
}
},
{
"_id": "req_f094a8fffd7d419caa696061",
"_type": "request",
"name": "Deletes a custom field definition for the user.",
"description": "Deletes a custom field definition for the user.",
"method": "DELETE",
"url": "{{ _.base_url }}/customFieldDefinitions",
"parentId": "req_aef46e40d9a14b699596344a",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {}
},
{
"_id": "req_eece8b8e818d4093b8bbfd1c",
"_type": "request_group",
"name": "Visual Inspection",
"description": "Manage visual inspection objects to embed AI-assisted processes on your shop floor.",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_fdacdbb275bf4385815f6b52",
"_type": "request",
"name": "Find visual inspections using the business context",
"description": "Find visual inspections using the business context. The business context can be one or more of the business objects that visual inspections can be assigned to.",
"method": "GET",
"url": "{{ _.base_url }}/v1/findVisualInspections()",
"parentId": "req_eece8b8e818d4093b8bbfd1c",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "The plant assigned to the visual inspection",
"disabled": false
},
{
"name": "material",
"value": "",
"description": "The material assigned to the visual inspection",
"disabled": true
},
{
"name": "materialVersion",
"value": "",
"description": "The version of the material assigned to the visual inspection",
"disabled": true
},
{
"name": "routing",
"value": "",
"description": "The routing assigned to the visual inspection",
"disabled": true
},
{
"name": "routingType_code",
"value": "",
"description": "The type of the routing assigned to the visual inspection",
"disabled": true
},
{
"name": "routingVersion",
"value": "",
"description": "The version of the routing assigned to the visual inspection",
"disabled": true
},
{
"name": "operation",
"value": "",
"description": "The operation activity assigned to the visual inspection",
"disabled": true
},
{
"name": "operationVersion",
"value": "",
"description": "The version of the operation activity assigned to the visual inspection",
"disabled": true
},
{
"name": "workCenter",
"value": "",
"description": "The work center assigned to the visual inspection",
"disabled": true
},
{
"name": "resource",
"value": "",
"description": "The resource assigned to the visual inspection",
"disabled": true
},
{
"name": "shopOrder",
"value": "",
"description": "The order assigned to the visual inspection",
"disabled": true
},
{
"name": "$expand",
"value": "",
"description": "The value of $expand query option is a comma-separated list of navigation property names, stream property names, or $value indicating the stream content of a media-entity. The corresponding related entities and stream values will be represented inline, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_57e5dde7afa74f629ac2929a",
"_type": "request_group",
"name": "Visual Inspection Result Service",
"description": "Log, read and store images of visual inspection results in Digital Manufacturing",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_a811538cc55847aaa0432efe",
"_type": "request",
"name": "Finds all visual inspection results.",
"description": "Finds all visual inspection results using various filter parameters",
"method": "GET",
"url": "{{ _.base_url }}/inspectionResults",
"parentId": "req_57e5dde7afa74f629ac2929a",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "$filter",
"value": "",
"description": "Filters items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
"disabled": true
},
{
"name": "$orderby",
"value": "",
"description": "Orders items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
"disabled": true
},
{
"name": "$select",
"value": "",
"description": "Selects properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"disabled": true
},
{
"name": "$expand",
"value": "",
"description": "The value of the $expand query option is a comma-separated list of navigation property names, stream property names, or a value indicating the stream content of a media-entity. The corresponding related entities and stream values will be represented inline, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_bc424dea1ee34edbb48a7d88",
"_type": "request",
"name": "Create a visual inspection result.",
"description": "Create a visual inspection result.",
"method": "POST",
"url": "{{ _.base_url }}/inspectionResults",
"parentId": "req_57e5dde7afa74f629ac2929a",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"conformanceStatus_code\": \"string\",\n \"executedAt\": \"2024-01-01T00:00:00Z\",\n \"inspectionMode_code\": \"string\",\n \"inspectionType_code\": \"string\",\n \"inspectionViewDescription\": \"string\",\n \"inspectionViewId\": \"string\",\n \"inspectionViewName\": \"string\",\n \"material\": \"string\",\n \"materialVersion\": \"string\",\n \"modelName\": \"string\",\n \"modelVersion\": \"string\",\n \"ncResults\": [\n {\n \"className\": \"string\",\n \"conformanceType_code\": \"string\",\n \"description\": \"string\",\n \"groundTruthBoundingBox\": {\n \"height\": {},\n \"isPredicted\": {},\n \"topLeftX\": {},\n \"topLeftY\": {},\n \"width\": {}\n },\n \"ncName\": \"string\",\n \"operatorResult_code\": \"string\",\n \"predictedBoundingBox\": {\n \"height\": {},\n \"topLeftX\": {},\n \"topLeftY\": {},\n \"width\": {}\n },\n \"prediction\": {},\n \"threshold\": {}\n }\n ],\n \"operationActivityName\": \"string\",\n \"operationActivityVersion\": \"string\",\n \"orderName\": \"string\",\n \"plant\": \"string\",\n \"resourceName\": \"string\",\n \"routingName\": \"string\",\n \"routingStepId\": \"string\",\n \"routingType\": \"string\",\n \"routingVersion\": \"string\",\n \"scenarioId\": \"string\",\n \"scenarioName\": \"string\",\n \"scenarioVersion\": \"string\",\n \"scenarioViewId\": \"string\",\n \"sfcId\": \"string\",\n \"source\": \"string\",\n \"workCenterName\": \"string\"\n}"
}
},
{
"_id": "req_5bfc1cf2335645399887db2c",
"_type": "request",
"name": "Finds a single visual inspection result by ID.",
"description": "Find a single inspection result by providing its ID",
"method": "GET",
"url": "{{ _.base_url }}/inspectionResults({id})",
"parentId": "req_57e5dde7afa74f629ac2929a",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "$select",
"value": "",
"description": "Selects properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"disabled": true
},
{
"name": "$expand",
"value": "",
"description": "The value of the $expand query option is a comma-separated list of navigation property names, stream property names, or a value indicating the stream content of a media-entity. The corresponding related entities and stream values will be represented inline, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_15968c759efa4b02bf09db85",
"_type": "request",
"name": "Get the image of a visual inspection result.",
"description": "Get the image of a visual inspection result by providing the associated visual inspection result ID.",
"method": "GET",
"url": "{{ _.base_url }}/inspectionResults({id})/image",
"parentId": "req_57e5dde7afa74f629ac2929a",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {}
},
{
"_id": "req_533462cf68764ac7914b3449",
"_type": "request",
"name": "Stores an image for a visual inspection result.",
"description": "Stores an image for a visual inspection result by providing the associated visual inspection result ID.",
"method": "PUT",
"url": "{{ _.base_url }}/inspectionResults({id})/image",
"parentId": "req_57e5dde7afa74f629ac2929a",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {}
},
{
"_id": "req_0ea30757fdd24b5185d4f2e0",
"_type": "request_group",
"name": "Work Center",
"description": "Get a list of work centers for a given plant.",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_bb39f4cc903448258180e03f",
"_type": "request",
"name": "Retrieves work centers.",
"description": "Retrieves a list of work centers by name and plant.",
"method": "GET",
"url": "{{ _.base_url }}/workcenters",
"parentId": "req_0ea30757fdd24b5185d4f2e0",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "The plant containing a work center.",
"disabled": false
},
{
"name": "workCenter",
"value": "",
"description": "The name to retrieve a work center.",
"disabled": false
}
],
"authentication": {}
},
{
"_id": "req_a50db464c0fd4464b29d8eea",
"_type": "request_group",
"name": "Work Center",
"description": "Retrieves work centers for a given plant.",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_ec29f6ee661945cd983f1201",
"_type": "request",
"name": "Searches for a single work center by plant and work center values.",
"description": "Searches for a work center by a given plant and work center name. Returns the details for the found work center.",
"method": "GET",
"url": "{{ _.base_url }}/workcenter",
"parentId": "req_a50db464c0fd4464b29d8eea",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "The plant where a work center is defined.",
"disabled": false
},
{
"name": "workCenter",
"value": "",
"description": "The work center value.",
"disabled": false
}
],
"authentication": {}
},
{
"_id": "req_6da0ff70a8f14cd3bd932d9f",
"_type": "request",
"name": "Searches for work centers by plant and work center values.",
"description": "Searches for a work center for a given plant and returns the details.",
"method": "GET",
"url": "{{ _.base_url }}/workcenters",
"parentId": "req_a50db464c0fd4464b29d8eea",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "The plant where a work center is defined.",
"disabled": false
},
{
"name": "workCenter",
"value": "",
"description": "The work center value.",
"disabled": true
},
{
"name": "assignedUser",
"value": "",
"description": "The user identifier.",
"disabled": true
},
{
"name": "resourceMembers",
"value": "",
"description": "The resource members.",
"disabled": true
},
{
"name": "size",
"value": "",
"description": "The quantity of work center records to be returned. If it is not specified, the default value is 100. The maximum allowed value is 100.",
"disabled": true
},
{
"name": "page",
"value": "",
"description": "The number of a page to be returned. The page number starts from 0. If it is not defined, the first page is returned.",
"disabled": true
},
{
"name": "sort",
"value": "",
"description": "This parameter is used for sorting. To define the sorting order, use comma-separated values, like 'workcenter,desc'. The default sorting order is ascending. The following sorting parameters are supported: modifiedDateTime, createdDateTime, workcenter, description, and status.",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_ec1cc45a063944a19945eebd",
"_type": "request_group",
"name": "Work Center",
"description": "Maintain work centers for a given plant.",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_feded98854c04b80a0110706",
"_type": "request",
"name": "Searches for work centers by plant and work center values.",
"description": "Searches for a work center for a given plant and returns the details for the same. This endpoint is now deprecated, please use the successor API Get Work Centers",
"method": "GET",
"url": "{{ _.base_url }}/workcenters",
"parentId": "req_ec1cc45a063944a19945eebd",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "The plant where a work center is defined.",
"disabled": false
},
{
"name": "workCenter",
"value": "",
"description": "The work center value.",
"disabled": true
},
{
"name": "assignedUser",
"value": "",
"description": "The user identifier.",
"disabled": true
},
{
"name": "resourceMembers",
"value": "",
"description": "The resource members.",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_27e6eba1fd5849268ed971f9",
"_type": "request",
"name": "Creates a work center.",
"description": "Creates a work center for a given plant.",
"method": "POST",
"url": "{{ _.base_url }}/workcenters",
"parentId": "req_ec1cc45a063944a19945eebd",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"plant\": \"string\",\n \"status\": \"string\",\n \"workCenter\": \"string\"\n}"
}
},
{
"_id": "req_43a3affbabaa4aee89426a16",
"_type": "request",
"name": "Updates the given work center.",
"description": "Updates a work center for a given plant.",
"method": "PATCH",
"url": "{{ _.base_url }}/workcenters",
"parentId": "req_ec1cc45a063944a19945eebd",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"plant\": \"string\",\n \"status\": \"string\",\n \"workCenter\": \"string\"\n}"
}
},
{
"_id": "req_25a3feffbec74fa59032405f",
"_type": "request",
"name": "Removes the given work center.",
"description": "Removes a work center for a given plant",
"method": "DELETE",
"url": "{{ _.base_url }}/workcenters",
"parentId": "req_ec1cc45a063944a19945eebd",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {}
},
{
"_id": "req_c08878f7d2ae43939cedaff1",
"_type": "request",
"name": "Retrieves a list of custom field definitions for the work center.",
"description": "Returns all maintained custom field definitions, for a given plant.",
"method": "GET",
"url": "{{ _.base_url }}/customFieldDefinitions",
"parentId": "req_ec1cc45a063944a19945eebd",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "The plant where a custom field definitions are defined.",
"disabled": false
}
],
"authentication": {}
},
{
"_id": "req_19ed8a7234d54702977da1e7",
"_type": "request",
"name": "Creates a custom field definition for the work center.",
"description": "Creates a custom field definition for the work center in a given plant and field name.",
"method": "POST",
"url": "{{ _.base_url }}/customFieldDefinitions",
"parentId": "req_ec1cc45a063944a19945eebd",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"fieldName\": \"string\",\n \"plant\": \"string\"\n}"
}
},
{
"_id": "req_eda002b40aa04553af68d6d6",
"_type": "request",
"name": "Updates a custom field definition for the work center.",
"description": "Updates field label or sequence in the custom field definition for the work center.",
"method": "PATCH",
"url": "{{ _.base_url }}/customFieldDefinitions",
"parentId": "req_ec1cc45a063944a19945eebd",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"fieldName\": \"string\",\n \"modifiedDateTime\": \"2024-01-01T00:00:00Z\",\n \"plant\": \"string\"\n}"
}
},
{
"_id": "req_ec25a5dccd174622abf915d7",
"_type": "request",
"name": "Deletes a custom field definition for the work center.",
"description": "Removes a custom field definition for a given work center.",
"method": "DELETE",
"url": "{{ _.base_url }}/customFieldDefinitions",
"parentId": "req_ec1cc45a063944a19945eebd",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {}
},
{
"_id": "req_b4b688b8a0d8484181a9e92b",
"_type": "request_group",
"name": "Work Instruction",
"description": "Get a list of work instructions or one single work instruction",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_ea2d9b6142944bfb87bc5007",
"_type": "request",
"name": "Get list of work instructions according to the parameters.",
"description": "Retrieves the list of work instructions based on the passed context. Reference to at least one of the objects should be passed apart from the plant. API returns empty list if only plant is provided. When sfc is provided as a parameter then list of attached work instructions is determined based on current sfc state (similar to what POD does).",
"method": "GET",
"url": "{{ _.base_url }}/v1/attachedworkinstructions",
"parentId": "req_b4b688b8a0d8484181a9e92b",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "operationactivity",
"value": "",
"description": "Operation activity for which work instructions are requested. Current revision is used.",
"disabled": true
},
{
"name": "plant",
"value": "",
"description": "Plant for which the request is executed.",
"disabled": false
},
{
"name": "resource",
"value": "",
"description": "Resource for which work instructions are requested.",
"disabled": true
},
{
"name": "routing",
"value": "",
"description": "Routing for which work instructions are requested. Current revision is used.",
"disabled": true
},
{
"name": "routingstepid",
"value": "",
"description": "Routing step for which work instructions are requested.",
"disabled": true
},
{
"name": "routingtype",
"value": "",
"description": "Routing type for which work instructions are requested. \nPossible values: \nPRODUCTION - Production Router (default value if parameter is not provided) \nSHOP_ORDER - Shop Order-specific Router \nSPECIAL - Special Operation Router \nNC - NC (Rework) Router) \nDISPOSITION - Disposition Router (used in disposition groups) \nCONFIGURABLE - Configurable Router Type \n",
"disabled": true
},
{
"name": "sfc",
"value": "",
"description": "SFC for which work instructions are requested. If SFC is provided, then work instructions are retrieved for the following assignments determined by SFC:\n1. Material \n2. Operation Activity Master \n3. Routing \n4. Order \n5. Work Center \n6. Resource \n7. Routing Step \n",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_133ff454fb5244fa9cedc43a",
"_type": "request",
"name": "Finds a work instruction by plant, name, and work instruction version",
"description": "Reads a work instruction based on the passed key fields - plant, work instruction name, and work instruction version.",
"method": "GET",
"url": "{{ _.base_url }}/v1/workinstructions",
"parentId": "req_b4b688b8a0d8484181a9e92b",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "Plant for which request is executed",
"disabled": false
},
{
"name": "workinstruction",
"value": "",
"description": "Work instruction name",
"disabled": false
},
{
"name": "version",
"value": "",
"description": "The version of the work instruction. If not present, the current work insturction version will be returned",
"disabled": true
}
],
"authentication": {}
},
{
"_id": "req_f097dcb196f84210afbd52e9",
"_type": "request",
"name": "Creates a work instruction by plant and name",
"description": "Creates a work instruction which can be attached to other objects like Material, Resource, Order and Work center etc.",
"method": "POST",
"url": "{{ _.base_url }}/v1/workinstructions",
"parentId": "req_b4b688b8a0d8484181a9e92b",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"plant\": \"string\",\n \"version\": \"string\",\n \"workInstruction\": \"string\"\n}"
}
},
{
"_id": "req_369fcf76e4df49ac9cffcb4d",
"_type": "request",
"name": "Updates a list of work instructions for the given plant.",
"description": "Updates a work instruction which can be attached to other objects like a material, resource, order and work center.",
"method": "PUT",
"url": "{{ _.base_url }}/v1/workinstructions",
"parentId": "req_b4b688b8a0d8484181a9e92b",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "[\n {\n \"attachedPoints\": [\n {\n \"headerMaterial\": {},\n \"material\": {},\n \"operationActivity\": {},\n \"resource\": {},\n \"routing\": {},\n \"routingStep\": {},\n \"sequence\": {},\n \"shopOrder\": {},\n \"workCenter\": {}\n }\n ],\n \"createdDateTime\": \"2024-01-01T00:00:00Z\",\n \"currentVersion\": true,\n \"customValues\": [\n {\n \"attribute\": {},\n \"value\": {}\n }\n ],\n \"description\": \"string\",\n \"instructionData\": \"string\",\n \"modifiedDateTime\": \"2024-01-01T00:00:00Z\",\n \"plant\": \"string\",\n \"required\": true,\n \"status\": \"string\",\n \"trackViewing\": true,\n \"version\": \"string\",\n \"workInstruction\": \"string\",\n \"workInstructionElements\": [\n {\n \"description\": {},\n \"erpFilename\": {},\n \"fileExternalUrl\": {},\n \"fileName\": {},\n \"metadataCategory\": {},\n \"metadataComponent\": {},\n \"metadataRefDes\": {},\n \"mimeType\": {},\n \"newWindow\": {},\n \"sequence\": {},\n \"text\": {},\n \"type\": {},\n \"url\": {}\n }\n ]\n }\n]"
}
},
{
"_id": "req_f1611991bb3648fa8a3cf6f3",
"_type": "request",
"name": "Deletes a work instruction by reference",
"description": "Deletes a work instruction based on the key fields passed, such as plant, version and work instruction name.",
"method": "DELETE",
"url": "{{ _.base_url }}/v1/workinstructions",
"parentId": "req_b4b688b8a0d8484181a9e92b",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "Plant for which the work instruction is executed.",
"disabled": false
},
{
"name": "workinstruction",
"value": "",
"description": "Work instruction name",
"disabled": false
},
{
"name": "version",
"value": "",
"description": "Version",
"disabled": false
}
],
"authentication": {}
},
{
"_id": "req_47c8119873c84e0c9215351c",
"_type": "request",
"name": "Creates a list of work instructions for the given plant.",
"description": "Creates a work instruction which can be attached to other objects like a material, resource, order and work center.",
"method": "POST",
"url": "{{ _.base_url }}/v2/workinstructions",
"parentId": "req_b4b688b8a0d8484181a9e92b",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "[\n {\n \"attachedPoints\": [\n {\n \"headerMaterial\": {},\n \"material\": {},\n \"operationActivity\": {},\n \"resource\": {},\n \"routing\": {},\n \"routingStep\": {},\n \"sequence\": {},\n \"shopOrder\": {},\n \"workCenter\": {}\n }\n ],\n \"createdDateTime\": \"2024-01-01T00:00:00Z\",\n \"currentVersion\": true,\n \"customValues\": [\n {\n \"attribute\": {},\n \"value\": {}\n }\n ],\n \"description\": \"string\",\n \"instructionData\": \"string\",\n \"modifiedDateTime\": \"2024-01-01T00:00:00Z\",\n \"plant\": \"string\",\n \"required\": true,\n \"status\": \"string\",\n \"trackViewing\": true,\n \"version\": \"string\",\n \"workInstruction\": \"string\",\n \"workInstructionElements\": [\n {\n \"description\": {},\n \"erpFilename\": {},\n \"fileExternalUrl\": {},\n \"fileName\": {},\n \"metadataCategory\": {},\n \"metadataComponent\": {},\n \"metadataRefDes\": {},\n \"mimeType\": {},\n \"newWindow\": {},\n \"sequence\": {},\n \"text\": {},\n \"type\": {},\n \"url\": {}\n }\n ]\n }\n]"
}
},
{
"_id": "req_2113086f14d44bc0924489d6",
"_type": "request",
"name": "Adds work instruction attached points.",
"description": "Adds work instruction attached points to a particular work instruction and work instruction version. This API endpoint has a fast performance as no validation is provided for fields in the payload request.",
"method": "POST",
"url": "{{ _.base_url }}/v1/workinstructions/attachedPoints",
"parentId": "req_b4b688b8a0d8484181a9e92b",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "plant",
"value": "",
"description": "Plant for which the request is executed.",
"disabled": false
},
{
"name": "workinstruction",
"value": "",
"description": "Work instruction name.",
"disabled": false
},
{
"name": "version",
"value": "",
"description": "Work instruction version.",
"disabled": false
}
],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "[\n {\n \"headerMaterial\": true,\n \"material\": {\n \"material\": \"string\",\n \"plant\": \"string\",\n \"version\": \"string\"\n },\n \"operationActivity\": {\n \"operationActivity\": \"string\",\n \"plant\": \"string\",\n \"version\": \"string\"\n },\n \"resource\": \"string\",\n \"routing\": {\n \"plant\": \"string\",\n \"routing\": \"string\",\n \"routingType\": \"string\",\n \"version\": \"string\"\n },\n \"routingStep\": \"string\",\n \"sequence\": 0.0,\n \"shopOrder\": \"string\",\n \"workCenter\": \"string\"\n }\n]"
}
},
{
"_id": "req_cc7f48e138af45889643baff",
"_type": "request_group",
"name": "Work Instruction Attached File",
"description": "Upload File for Work Instruction Attachment",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_411c2a3599424861ab1360fb",
"_type": "request",
"name": "Download a file content by provided external file URL.",
"description": "This API is called to download file content by using the provided external URL.",
"method": "GET",
"url": "{{ _.base_url }}/file",
"parentId": "req_cc7f48e138af45889643baff",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [
{
"name": "externalFileUrl",
"value": "",
"description": "The external url of the file to download",
"disabled": false
}
],
"authentication": {}
},
{
"_id": "req_7b566d0314a44348854aef05",
"_type": "request",
"name": "Uploads a file for further use during the creation of the Work Instruction Attachment.",
"description": "This API is called to upload a file. The external URL of the uploaded file can be used during the creation of work instruction attachments.",
"method": "POST",
"url": "{{ _.base_url }}/file",
"parentId": "req_cc7f48e138af45889643baff",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {}
},
{
"_id": "req_d080e4c08fe24080bad97ea1",
"_type": "request_group",
"name": "Work in Process (WIP) Activities",
"description": "Perform production activities for work-in-process (WIP) products, such as storing, staging and consuming them by posting WIP requests to Extended Warehouse Management",
"parentId": "req_363edd3a8de44838a8436f31"
},
{
"_id": "req_3a33738df19a4284a6d47467",
"_type": "request",
"name": "Posts a work-in-process (WIP) storage request to EWM.",
"description": "Posts a WIP storage request to EWM for a given plant. You can include WIP products from one or more orders in a single request, as long as you store them in the same warehouse.",
"method": "POST",
"url": "{{ _.base_url }}/storageRequest",
"parentId": "req_d080e4c08fe24080bad97ea1",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"items\": [\n {\n \"productionSupplyArea\": \"string\"\n }\n ],\n \"plant\": \"string\"\n}"
}
},
{
"_id": "req_225c7b6deac846ab9c62d454",
"_type": "request",
"name": "Posts a work-in-process (WIP) staging request to EWM.",
"description": "Posts a WIP staging request to EWM for a given plant.",
"method": "POST",
"url": "{{ _.base_url }}/stagingRequest",
"parentId": "req_d080e4c08fe24080bad97ea1",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"items\": [\n {\n \"productionSupplyArea\": \"string\"\n }\n ],\n \"plant\": \"string\"\n}"
}
},
{
"_id": "req_c0e5d64bf69a40aa89542bcb",
"_type": "request",
"name": "Posts a WIP goods issue request to EWM.",
"description": "Posts a WIP goods issue request to EWM for a given plant.",
"method": "POST",
"url": "{{ _.base_url }}/goodsIssueRequest",
"parentId": "req_d080e4c08fe24080bad97ea1",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"items\": [\n {\n \"productionSupplyArea\": \"string\"\n }\n ],\n \"plant\": \"string\"\n}"
}
},
{
"_id": "req_b6f903b2256a41f7937661a2",
"_type": "request",
"name": "Discards a work-in-process (WIP) storage request.",
"description": "Discards a WIP storage request for a given plant and storage request number.",
"method": "POST",
"url": "{{ _.base_url }}/storageRequest/discard",
"parentId": "req_d080e4c08fe24080bad97ea1",
"headers": [
{
"name": "Content-Type",
"value": "application/json"
},
{
"name": "Authorization",
"value": "Bearer {{ _.token }}"
}
],
"parameters": [],
"authentication": {},
"body": {
"mimeType": "application/json",
"text": "{\n \"storageRequestNumber\": \"string\"\n}"
}
}
]
}