Creates a new job work instruction list.
Request Information
URI Parameters :
None.
Body Parameters :
job_work_instruction_list| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Primary Key |
globally unique identifier |
Required |
| jobs_id |
Foreign key of the jobs |
globally unique identifier |
Optionally required : jobs_id, jobs_reference_back_office or jobs must be provided |
| jobs_reference_back_office |
Embedded entity "jobs" using ERP PK when adding/updating |
string |
Optionally required : jobs_id, jobs_reference_back_office or jobs must be provided |
| jobs |
Embedded entity "jobs" when adding/updating |
jobs |
Optionally required : jobs_id, jobs_reference_back_office or jobs must be provided |
| work_instruction_details_id |
work instruction details id |
globally unique identifier | |
| work_instruction_details_reference_back_office |
Embedded code "work instruction details" when adding/updating |
string | |
| work_instruction_details |
Embedded entity "work instruction details" when adding/updating |
work_instruction_details | |
| user_id |
Filled by the person that completed that item on the checklist |
globally unique identifier | |
| work_instruction_action_type |
Value from work_instruction_action_type.name |
string | |
| work_instruction_id |
work instruction id |
globally unique identifier |
Optionally required : work_instruction_id,work_instruction_reference_back_office or work_instruction must be provided |
| work_instruction_reference_back_office |
Embedded code "work instruction" when adding/updating |
string |
Optionally required : work_instruction_id,work_instruction_reference_back_office or work_instruction must be provided |
| work_instruction |
Embedded entity "work instruction" when adding/updating |
work_instruction |
Optionally required : work_instruction_id,work_instruction_reference_back_office or work_instruction must be provided |
| name |
The "on what" |
string |
Required Max length: 4000 |
| status |
Status can be Ok,NotOk,Replaced,NotApplicable |
string |
Max length: 50 |
| date_done |
Datetime filled when status goes to one valable status. |
date | |
| remark |
Additional remark from the technician. |
string |
Max length: 255 |
| advise |
Additional advice from the technician. |
string |
Max length: 255 |
| sequence |
To order it. |
integer | |
| reference_back_office |
The Id/Ref of the back office for this job work instruction. Used by Embedded entity |
string |
Max length: 255 |
| group_name |
Name of the group |
string |
Max length: 4000 |
| group_sequence |
Order of the group |
integer | |
| type |
One of the possible types which are Regular, Form, Picture, UsedParts, BillableHours. Regular is the default |
string | |
| instruction_document_count |
Specify how many documents/photos must be added if type is Picture |
integer | |
| db_report_type_id |
When type is Form, you must specify which db_report_type must be filled |
globally unique identifier | |
| db_report_type_name |
When type is Form, you must specify which db_report_type must be filled |
string | |
| modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date |
Request Formats :
application/json, text/json
Sample:
{
"id": "4ce59b58-463e-4d62-a91c-1be1cf1033a8",
"jobs_id": "224bb1fa-672b-4925-9160-7603afa5fb2b",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "e3e7873a-2061-49b6-89d4-a88b0a125020",
"_parent_id": "0d86082f-98ed-4869-8d23-8e012b56cafe",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "325a1655-b5de-4ac9-9f43-4ff9c103188c",
"project_reference_back_office": "sample string 5",
"project": {
"id": "38fd9620-1b85-4565-adcd-85bde037c4f5",
"_parent_id": "e3dee1a9-4948-411f-8ef2-75932a692f87",
"root_parent_id": "7746fa3e-a640-4f74-8aa4-52631f9755ec",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "60197146-a794-487d-b542-dd16dd5b919e",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "effe9085-27f4-464a-9a1e-350430a0bb02",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "cb5384b3-cdfa-45b1-9c65-47b354bfc764",
"_parent_code": "sample string 6",
"sales_organization_id": "e6e61bf9-b979-4b93-8f02-918f78804b39",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "dd3bc77b-7a8e-43c0-bfd3-62d8e99bf3e6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1c6395b5-88f6-400e-b92c-662827013e21",
"db_currency_id": "5600aa1f-b156-4dee-ae58-f3f66b5ee3f4",
"db_language_id": "21d1ba68-3b62-43f8-a76f-81bd8b8fbe55",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-07-08T22:17:48.3599093+00:00"
},
"modified_dateutc": "2026-07-08T22:17:48.3599093+00:00"
},
"equipment_model_id": "88e222e9-4249-41f7-b5c0-8e921c3dadab",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "c39996a1-3a94-4b50-8a6c-13cc8a57a9ba",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "dc85bd07-f34c-48af-b9c5-0b40bb886ede",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "27ab5120-469b-410e-a320-f847bab9a882",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "d7731f5d-a11a-4cc2-a011-63267c2ef38e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "dd3bc77b-7a8e-43c0-bfd3-62d8e99bf3e6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1c6395b5-88f6-400e-b92c-662827013e21",
"db_currency_id": "5600aa1f-b156-4dee-ae58-f3f66b5ee3f4",
"db_language_id": "21d1ba68-3b62-43f8-a76f-81bd8b8fbe55",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-07-08T22:17:48.3599093+00:00"
},
"modified_dateutc": "2026-07-08T22:17:48.3599093+00:00"
},
"equipment_family_id": "0f988ddd-f5b6-48a0-bc62-c5922527094f",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "effe9085-27f4-464a-9a1e-350430a0bb02",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "cb5384b3-cdfa-45b1-9c65-47b354bfc764",
"_parent_code": "sample string 6",
"sales_organization_id": "e6e61bf9-b979-4b93-8f02-918f78804b39",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "dd3bc77b-7a8e-43c0-bfd3-62d8e99bf3e6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1c6395b5-88f6-400e-b92c-662827013e21",
"db_currency_id": "5600aa1f-b156-4dee-ae58-f3f66b5ee3f4",
"db_language_id": "21d1ba68-3b62-43f8-a76f-81bd8b8fbe55",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-07-08T22:17:48.3599093+00:00"
},
"modified_dateutc": "2026-07-08T22:17:48.3599093+00:00"
},
"date_in_production_since": "2026-07-08T22:17:48.3599093+00:00",
"date_out_of_production_since": "2026-07-08T22:17:48.3599093+00:00",
"date_end_support": "2026-07-08T22:17:48.3599093+00:00",
"sales_organization_id": "dd5c1ec6-c26b-40a6-b261-fd0893d0ed96",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "dd3bc77b-7a8e-43c0-bfd3-62d8e99bf3e6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1c6395b5-88f6-400e-b92c-662827013e21",
"db_currency_id": "5600aa1f-b156-4dee-ae58-f3f66b5ee3f4",
"db_language_id": "21d1ba68-3b62-43f8-a76f-81bd8b8fbe55",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-07-08T22:17:48.3599093+00:00"
},
"replacement_period_nb_months": 14,
"warranty_period_nb_months": 15,
"translations": [
{
"field_name": "sample string 1",
"language_code": "sample string 2",
"value_translated": "sample string 3"
},
{
"field_name": "sample string 1",
"language_code": "sample string 2",
"value_translated": "sample string 3"
}
],
"modified_dateutc": "2026-07-08T22:17:48.3599093+00:00"
},
"project_status_id": "6011029f-d43a-4777-aceb-34628efd9a9e",
"project_status_code": "sample string 10",
"project_status": {
"id": "08be47bb-2f7a-4f62-9d5a-dac35beec34c",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "46a2280b-9f29-42e7-afbb-14f743f7b58b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "dd3bc77b-7a8e-43c0-bfd3-62d8e99bf3e6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1c6395b5-88f6-400e-b92c-662827013e21",
"db_currency_id": "5600aa1f-b156-4dee-ae58-f3f66b5ee3f4",
"db_language_id": "21d1ba68-3b62-43f8-a76f-81bd8b8fbe55",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-07-08T22:17:48.3599093+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-08T22:17:48.3599093+00:00"
},
"company_id": "cc6c76ec-e615-4114-a835-45ab02e4a899",
"company_code": "sample string 12",
"db_address_id": "ee9e237b-448c-43b7-88e6-08b945846d0a",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "31743a6b-654d-4475-8ae8-ee605052aec3",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "27e8bd03-a0b1-4cef-9b3f-bea933d52d5d",
"name": "sample string 19",
"description": "sample string 20",
"reference_back_office": "sample string 21",
"serial_number": "sample string 22",
"barcode": "sample string 23",
"date_start_production": "2026-07-08T22:17:48.3599093+00:00",
"date_create": "2026-07-08T22:17:48.3599093+00:00",
"date_update": "2026-07-08T22:17:48.3599093+00:00",
"updated_by_user_id": "1cd76c2d-c565-48b8-8c47-15450a22e747",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-08T22:17:48.3599093+00:00",
"last_standard_result_score_1": "sample string 30",
"last_standard_result_score_2": "sample string 31",
"target_standard_result_score_1": "sample string 32",
"target_standard_result_score_2": "sample string 33",
"date_built": "2026-07-08T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-08T22:17:48.3599093+00:00",
"date_last_job": "2026-07-08T22:17:48.3599093+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-08T22:17:48.3599093+00:00",
"modified_dateutc": "2026-07-08T22:17:48.3599093+00:00",
"is_mobile_installation": true
},
"job_type_id": "be904c04-a949-4cf1-9b5d-d508f2c9d468",
"job_type_code": "sample string 7",
"job_type": {
"id": "2d7cd46d-e02e-4b00-89a9-9e8ff0b581a8",
"name": "sample string 2",
"sales_organization_id": "0ac51c47-cb7b-42a7-97da-4710c3e02b06",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-08T22:17:48.3599093+00:00",
"code": "sample string 7"
},
"job_priority_id": "3e78ba3f-8b88-4c44-9a0a-13e82adbe209",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "41621e6e-ffbf-42de-9717-2c79b2b8f498",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "7552d8c4-1310-4050-adfc-d59d726295b4",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "dd3bc77b-7a8e-43c0-bfd3-62d8e99bf3e6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1c6395b5-88f6-400e-b92c-662827013e21",
"db_currency_id": "5600aa1f-b156-4dee-ae58-f3f66b5ee3f4",
"db_language_id": "21d1ba68-3b62-43f8-a76f-81bd8b8fbe55",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-07-08T22:17:48.3599093+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-08T22:17:48.3599093+00:00"
},
"job_status_id": "d004f733-0682-49ca-8f2f-bd91d8bed496",
"job_status_code": "sample string 11",
"db_address_id": "8d6c5c5f-b428-4371-aeec-e98c4cfd2ee5",
"contact_id": "ef1e2656-6c4a-427a-9e46-29fc770caf7c",
"requested_by_company_id": "8145990c-07db-4e81-9349-e7d505f50559",
"requested_by_contact_id": "8d8a90ac-f426-416c-9a73-c8d18cbee8c3",
"reference_back_office": "sample string 16",
"name": "sample string 17",
"description": "sample string 18",
"working_sequence": 19,
"internal_memo": "sample string 20",
"prejob_information": "sample string 21",
"estimated_time": 22,
"earliest_date_plannable": "2026-07-08T22:17:48.3755343+00:00",
"due_date": "2026-07-08T22:17:48.3755343+00:00",
"date_create": "2026-07-08T22:17:48.3755343+00:00",
"date_update": "2026-07-08T22:17:48.3755343+00:00",
"date_closed": "2026-07-08T22:17:48.3755343+00:00",
"suggested_user_id": "72290b4a-7933-4315-a015-208e769da0c6",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "de086d1e-0b23-454b-b1fd-f970c6ab7504",
"db_language_id": "84fb3b4d-a990-40b7-8879-bfbfeeceda76",
"username": "sample string 3",
"firstname": "sample string 4",
"lastname": "sample string 5",
"code": "sample string 6",
"archived": true,
"disabled": true,
"emergency_contact": "sample string 9",
"bankaccount": "sample string 10",
"social_security": "sample string 11",
"place_of_birth": "sample string 12",
"nationality": "sample string 13",
"functions": "sample string 14",
"birthdate": "2026-07-08T22:17:48.3755343+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "202163a2-5348-47aa-ab05-c6c622a9d4f7",
"sales_organization": {
"id": "dd3bc77b-7a8e-43c0-bfd3-62d8e99bf3e6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1c6395b5-88f6-400e-b92c-662827013e21",
"db_currency_id": "5600aa1f-b156-4dee-ae58-f3f66b5ee3f4",
"db_language_id": "21d1ba68-3b62-43f8-a76f-81bd8b8fbe55",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-07-08T22:17:48.3599093+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "f8f3dfd6-153f-46a4-b0eb-3de5fb5291e7",
"email": "sample string 22",
"phone": "sample string 23",
"fax": "sample string 24",
"mobile": "sample string 25",
"private_email": "sample string 26",
"private_phone": "sample string 27",
"private_fax": "sample string 28",
"private_mobile": "sample string 29",
"private_street": "sample string 30",
"private_street_number": "sample string 31",
"private_city": "sample string 32",
"private_zip": "sample string 33",
"private_db_country_id": "ad5f3b87-6735-4ecf-a673-b90338e71abd",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-08T22:17:48.3755343+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "00031bed-3cb5-401d-8817-ad5130b1faf4"
},
"suggested_date_start": "2026-07-08T22:17:48.3755343+00:00",
"skill_id": "6a137930-13c7-4c62-9b07-0be7276ed98e",
"skill_code": "sample string 32",
"skill": {
"id": "fe89564e-4e55-4cba-ac85-91e13ab1a1d0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "f1c3acbd-0acc-402f-92c9-0e156f773483",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "dd3bc77b-7a8e-43c0-bfd3-62d8e99bf3e6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1c6395b5-88f6-400e-b92c-662827013e21",
"db_currency_id": "5600aa1f-b156-4dee-ae58-f3f66b5ee3f4",
"db_language_id": "21d1ba68-3b62-43f8-a76f-81bd8b8fbe55",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-07-08T22:17:48.3599093+00:00"
},
"modified_dateutc": "2026-07-08T22:17:48.3755343+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "59685d61-2e83-4359-8234-943035f59927",
"date_reported_by_company": "2026-07-08T22:17:48.3755343+00:00",
"id2": 36,
"company_id": "97793390-8bbf-4de1-9e98-819579c1d413",
"company_code": "sample string 38",
"db_address_name": "sample string 39",
"db_address_street": "sample string 40",
"db_address_street2": "sample string 41",
"db_address_street_number": "sample string 42",
"db_address_city": "sample string 43",
"db_address_zip": "sample string 44",
"db_address_db_country_id": "b49599d8-43ea-4041-a59c-552ff220f86c",
"db_address_db_country_code": "sample string 46",
"db_address_phone": "sample string 47",
"db_address_email": "sample string 48",
"db_address_latitude_decimal": 49.0,
"db_address_longitude_decimal": 50.0,
"estimated_quantity_remark": "sample string 51",
"modified_dateutc": "2026-07-08T22:17:48.3755343+00:00"
},
"work_instruction_details_id": "3f2a6ff9-fecd-4936-aff0-b9a138c814f1",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "c9b2424a-6671-4863-8471-f8afbf93ae81",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "6651fcbf-8899-4d5f-bc04-e69aa7a7f31c",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-08T22:17:48.3755343+00:00",
"remark": "sample string 13",
"advise": "sample string 14",
"sequence": 1,
"reference_back_office": "sample string 15",
"group_name": "sample string 16",
"group_sequence": 1,
"type": "sample string 17",
"instruction_document_count": 1,
"db_report_type_id": "8a4de0ab-97cc-4fc8-8ba8-ee53cc39a930",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-08T22:17:48.3755343+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.