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": "9454cc4d-4f1e-4d78-b13e-c696b4d34ae8",
"jobs_id": "ddb2179f-fe2d-4e51-a901-f3b928b88156",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "26510f74-dd5a-4ab8-972f-5e371bc6dcc8",
"_parent_id": "27e57186-ece3-450c-ae52-73a893a6c906",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "1c901234-9e9f-481e-8e07-914dd188acfc",
"project_reference_back_office": "sample string 5",
"project": {
"id": "4c074a13-9a0b-4d2d-8e62-6d3fe2f2cad0",
"_parent_id": "15b4e761-d0d1-4e2d-97a9-1083a346c123",
"root_parent_id": "134ad375-5610-44c0-8112-62daaae48df8",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "76a28c79-1574-4ad9-a33d-a66d51a3db45",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "17759b77-9599-44fb-8623-37fba8fc4dc9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7d858152-3e4f-444c-9fb8-9d255a761adc",
"_parent_code": "sample string 6",
"sales_organization_id": "1cdedc07-5658-4ac7-bc24-525e918ad090",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "435c1911-d76b-4822-a16e-53a57d41e923",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "465e79ec-7c08-4172-a155-e5eb11f875f1",
"db_currency_id": "41a26dae-8157-46b7-b6f7-cf5313fccccf",
"db_language_id": "93a19ec8-fa70-435a-baf6-2ad76493f9c4",
"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-09-11T05:16:40.3479584+00:00"
},
"modified_dateutc": "2026-09-11T05:16:40.3479584+00:00"
},
"equipment_model_id": "beec7c12-84f2-4d62-a758-06d7eb234227",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "9562afe0-d862-47eb-bd41-4a939ca8eaea",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "3e712805-ac89-4db3-8443-17d21eed4cb8",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "ce5a3100-7bcd-4ae7-82f9-316c3f172a4c",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "f57d3c9f-42de-4b73-afe0-b0b5ace524eb",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "435c1911-d76b-4822-a16e-53a57d41e923",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "465e79ec-7c08-4172-a155-e5eb11f875f1",
"db_currency_id": "41a26dae-8157-46b7-b6f7-cf5313fccccf",
"db_language_id": "93a19ec8-fa70-435a-baf6-2ad76493f9c4",
"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-09-11T05:16:40.3479584+00:00"
},
"modified_dateutc": "2026-09-11T05:16:40.3479584+00:00"
},
"equipment_family_id": "b101eb61-ca24-4a8b-aa40-dd3a5bc99b5e",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "17759b77-9599-44fb-8623-37fba8fc4dc9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7d858152-3e4f-444c-9fb8-9d255a761adc",
"_parent_code": "sample string 6",
"sales_organization_id": "1cdedc07-5658-4ac7-bc24-525e918ad090",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "435c1911-d76b-4822-a16e-53a57d41e923",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "465e79ec-7c08-4172-a155-e5eb11f875f1",
"db_currency_id": "41a26dae-8157-46b7-b6f7-cf5313fccccf",
"db_language_id": "93a19ec8-fa70-435a-baf6-2ad76493f9c4",
"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-09-11T05:16:40.3479584+00:00"
},
"modified_dateutc": "2026-09-11T05:16:40.3479584+00:00"
},
"date_in_production_since": "2026-09-11T05:16:40.3479584+00:00",
"date_out_of_production_since": "2026-09-11T05:16:40.3479584+00:00",
"date_end_support": "2026-09-11T05:16:40.3479584+00:00",
"sales_organization_id": "e3672671-b15e-4ef3-b45f-685043a3beb7",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "435c1911-d76b-4822-a16e-53a57d41e923",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "465e79ec-7c08-4172-a155-e5eb11f875f1",
"db_currency_id": "41a26dae-8157-46b7-b6f7-cf5313fccccf",
"db_language_id": "93a19ec8-fa70-435a-baf6-2ad76493f9c4",
"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-09-11T05:16:40.3479584+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-09-11T05:16:40.3479584+00:00"
},
"project_status_id": "498969c0-b653-4231-a032-8231ef239871",
"project_status_code": "sample string 10",
"project_status": {
"id": "e771e99a-588d-4dce-878f-fc1eeee9c2fb",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "d68a9888-4308-40b1-a05d-d9692b21648f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "435c1911-d76b-4822-a16e-53a57d41e923",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "465e79ec-7c08-4172-a155-e5eb11f875f1",
"db_currency_id": "41a26dae-8157-46b7-b6f7-cf5313fccccf",
"db_language_id": "93a19ec8-fa70-435a-baf6-2ad76493f9c4",
"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-09-11T05:16:40.3479584+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-11T05:16:40.3479584+00:00"
},
"company_id": "492fece5-ffaf-4ac9-a911-93a38f4a5feb",
"company_code": "sample string 12",
"db_address_id": "393ac001-a650-4c20-90eb-296df5741c15",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "4406aa22-43e7-4fd5-89ac-30f4f6f93ac8",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "0bc74fff-9341-482d-9c23-6266c315e4e7",
"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-09-11T05:16:40.3635905+00:00",
"date_create": "2026-09-11T05:16:40.3635905+00:00",
"date_update": "2026-09-11T05:16:40.3635905+00:00",
"updated_by_user_id": "4902518b-5e21-464c-9724-4f0b2c309e99",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-11T05:16:40.3635905+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-09-11T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-11T05:16:40.3635905+00:00",
"date_last_job": "2026-09-11T05:16:40.3635905+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-11T05:16:40.3635905+00:00",
"modified_dateutc": "2026-09-11T05:16:40.3635905+00:00",
"is_mobile_installation": true
},
"job_type_id": "f7d717f4-8a0a-416b-85dd-b5a20925e70e",
"job_type_code": "sample string 7",
"job_type": {
"id": "850db88c-30b3-44b4-b90f-f08da468ecfb",
"name": "sample string 2",
"sales_organization_id": "3be3cbbf-eefb-41ad-91a9-80c9c2f4c1ba",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-11T05:16:40.3635905+00:00",
"code": "sample string 7"
},
"job_priority_id": "856d82d9-2d52-4a2b-aab9-41ffcb3ca160",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "9dbed282-018a-4ffa-aace-aa1515c8a012",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "65189a5a-5004-4f1f-b34d-fd695e2716f2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "435c1911-d76b-4822-a16e-53a57d41e923",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "465e79ec-7c08-4172-a155-e5eb11f875f1",
"db_currency_id": "41a26dae-8157-46b7-b6f7-cf5313fccccf",
"db_language_id": "93a19ec8-fa70-435a-baf6-2ad76493f9c4",
"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-09-11T05:16:40.3479584+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-11T05:16:40.3635905+00:00"
},
"job_status_id": "f78eb4af-1b2d-4deb-89ab-33a9d44de852",
"job_status_code": "sample string 11",
"db_address_id": "0a507aef-6a22-40e2-aa0b-3a0f2bd863b5",
"contact_id": "2a451475-dada-401f-89e5-0985a31c326a",
"requested_by_company_id": "c4c3dc58-d30c-47bf-bb74-8c3ee78451dd",
"requested_by_contact_id": "e5f35446-9bc1-4334-8dcc-c893dda13e41",
"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-09-11T05:16:40.3635905+00:00",
"due_date": "2026-09-11T05:16:40.3635905+00:00",
"date_create": "2026-09-11T05:16:40.3635905+00:00",
"date_update": "2026-09-11T05:16:40.3635905+00:00",
"date_closed": "2026-09-11T05:16:40.3635905+00:00",
"suggested_user_id": "a5b89a60-6b1a-4be3-9315-ffeac922266d",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "21d4962c-d17c-4c97-863f-8e615bbdf983",
"db_language_id": "471b1337-fcde-438a-a6c4-1b34da759936",
"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-09-11T05:16:40.3635905+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "6caad8fc-7bd1-4fc4-ba3b-0e2a5c19334e",
"sales_organization": {
"id": "435c1911-d76b-4822-a16e-53a57d41e923",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "465e79ec-7c08-4172-a155-e5eb11f875f1",
"db_currency_id": "41a26dae-8157-46b7-b6f7-cf5313fccccf",
"db_language_id": "93a19ec8-fa70-435a-baf6-2ad76493f9c4",
"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-09-11T05:16:40.3479584+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "2faf954f-bb02-43f4-bb32-8acbecae599e",
"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": "c67f21ef-2026-4415-b53f-d9ba00e9a991",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-11T05:16:40.3635905+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "b38f02f5-b7c9-482c-8bbc-d3131ddcd7b1"
},
"suggested_date_start": "2026-09-11T05:16:40.3635905+00:00",
"skill_id": "255a057d-db7d-4a10-b021-3f295a8f2620",
"skill_code": "sample string 32",
"skill": {
"id": "461018cf-faf3-4a0d-a5ac-a9d85b456f19",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "22267052-aaa0-41ed-a122-62ca4eeb08ba",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "435c1911-d76b-4822-a16e-53a57d41e923",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "465e79ec-7c08-4172-a155-e5eb11f875f1",
"db_currency_id": "41a26dae-8157-46b7-b6f7-cf5313fccccf",
"db_language_id": "93a19ec8-fa70-435a-baf6-2ad76493f9c4",
"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-09-11T05:16:40.3479584+00:00"
},
"modified_dateutc": "2026-09-11T05:16:40.3635905+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "25f2f5e5-d2e2-4a1f-8ea4-459efeec0745",
"date_reported_by_company": "2026-09-11T05:16:40.3635905+00:00",
"id2": 36,
"company_id": "2fc03cbd-8246-4283-9a06-203470190cb6",
"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": "c4cdca93-05c2-405d-b526-4dc3a64d6fa6",
"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-09-11T05:16:40.3635905+00:00"
},
"work_instruction_details_id": "1a04dd30-8316-4a83-af86-0a517d1648c0",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "d8f8c3ec-ca15-42c9-8f72-daccc77dd1c3",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "e64562e8-4574-4b32-b860-94069264243e",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-11T05:16:40.3635905+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": "80cdf71f-13e8-4b46-b1e4-ebf7e1629ab6",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-11T05:16:40.3635905+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.