Creates a new work instruction.

Request Information

URI Parameters :

None.

Body Parameters :

work_instruction
NameDescriptionTypeAdditional information
id

Primary Key

 globally unique identifier

Required
sales_organization_id

FK of sales_organization. Filled if specific of one SO, empty if can be used by all

 globally unique identifier
sales_organization_code

Embedded entity "sales_organization" using ERP PK when adding/updating work_instruction

 string
sales_organization

Embedded entity "sales_organization" when adding/updating work_instruction

 sales_organization
job_type_id

Applicable job_type

 globally unique identifier

Required
job_type_code

Applicable job_type

 string
equipment_family_id

Applicable equipment family

 globally unique identifier

Required
equipment_family_code

Applicable equipment family

 string
skill_ids

List of only applicable skils

 Collection of globally unique identifier
skill_codes

List of only applicable skils

 Collection of string
name

Name of the header of the work instruction.

 string

Required

Max length: 50
description

Explanation of these instructions for the technician.

 string

Required

Max length: 255
estimated_work_time

Time needed to complete these instructions. Number in minute.

 integer
additional_information

Additional information

 string

Max length: 4000
reference_back_office

The Id/Ref of the back office for this work instruction. Used by Embedded entity

 string

Max length: 255
is_required

If true then all instructions required to be executed

 boolean
is_archived

Specify if the object is not usable anymore

 boolean
modified_dateutc

Readonly system field managed by database, filled with GetUtcDate when adding,updating.

 date

Request Formats :

application/json, text/json

Sample: 
{
  "id": "125dc0b5-dd08-4cb0-89b5-40ab4549a5a0",
  "sales_organization_id": "0a0ad3e2-e7a2-4282-9700-6e6b7ee75c3b",
  "sales_organization_code": "sample string 3",
  "job_type_id": "3ca12900-2f24-43f3-83c2-b52e61acd4cd",
  "job_type_code": "sample string 5",
  "equipment_family_id": "802b770a-f537-4079-bfaf-8c02fa531a42",
  "equipment_family_code": "sample string 7",
  "skill_ids": [
    "7123f7df-6973-46c3-baf9-77c61855622a",
    "c8035d12-a423-4e2d-9a8f-daed7c095b36"
  ],
  "skill_codes": [
    "sample string 1",
    "sample string 2"
  ],
  "name": "sample string 8",
  "description": "sample string 9",
  "estimated_work_time": 10,
  "additional_information": "sample string 11",
  "reference_back_office": "sample string 12",
  "is_required": true,
  "is_archived": true,
  "modified_dateutc": "2025-05-17T17:08:34.8132405+00:00"
}

Response Information

Resource Description :

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.