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": "957abfe2-cc00-423a-b783-4a6e78f9eaf6",
"jobs_id": "48a359f4-5b6d-4204-9cbb-85b7553d79f6",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "89de180c-69e7-4531-9fba-62470e1d0960",
"_parent_id": "e057ea8e-f292-46d3-88fa-0973fc7830b9",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "a8124d2c-f817-473a-931c-466ca244ed2d",
"project_reference_back_office": "sample string 5",
"project": {
"id": "cdefce11-d769-4737-9409-59e01b2f70ab",
"_parent_id": "26bf4cc0-76a4-4ef9-a9e4-de01ca646b06",
"root_parent_id": "cc9aedc0-f95b-41b3-9e8a-622ed12be5d9",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "2ca8212f-8ebc-4d74-8aea-e97fb768b551",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "a803f05c-59c9-43d5-b272-11948f4fb7eb",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "29288574-8d4c-469f-8fe8-eb11762dfb70",
"_parent_code": "sample string 6",
"sales_organization_id": "05b309e0-9554-40dc-a786-97665194772c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "96acd54a-b06a-4688-8b6a-71d13e73ec9e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "37a0fef3-7543-4c2e-bd38-05e698c17141",
"db_currency_id": "47237842-8638-42d4-a3af-771ec989522e",
"db_language_id": "2575ba52-8811-429d-8c5b-7862df6ddd26",
"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-01-14T07:01:56.438766+00:00"
},
"modified_dateutc": "2026-01-14T07:01:56.438766+00:00"
},
"equipment_model_id": "dbc19790-4dec-44b5-ba8d-d19f6413bfa8",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "94956a44-a059-47da-a6d3-c1e3c2460400",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "96b11650-ecfa-473c-b971-50a8a531fb75",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "f32a2a2a-2c6e-43e1-9790-d5471b119bc3",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "6334860f-b360-4d91-905f-3eab2e8a8693",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "96acd54a-b06a-4688-8b6a-71d13e73ec9e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "37a0fef3-7543-4c2e-bd38-05e698c17141",
"db_currency_id": "47237842-8638-42d4-a3af-771ec989522e",
"db_language_id": "2575ba52-8811-429d-8c5b-7862df6ddd26",
"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-01-14T07:01:56.438766+00:00"
},
"modified_dateutc": "2026-01-14T07:01:56.438766+00:00"
},
"equipment_family_id": "50cc960a-59ac-4aa6-bdfe-dbe72a88618c",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "a803f05c-59c9-43d5-b272-11948f4fb7eb",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "29288574-8d4c-469f-8fe8-eb11762dfb70",
"_parent_code": "sample string 6",
"sales_organization_id": "05b309e0-9554-40dc-a786-97665194772c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "96acd54a-b06a-4688-8b6a-71d13e73ec9e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "37a0fef3-7543-4c2e-bd38-05e698c17141",
"db_currency_id": "47237842-8638-42d4-a3af-771ec989522e",
"db_language_id": "2575ba52-8811-429d-8c5b-7862df6ddd26",
"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-01-14T07:01:56.438766+00:00"
},
"modified_dateutc": "2026-01-14T07:01:56.438766+00:00"
},
"date_in_production_since": "2026-01-14T07:01:56.438766+00:00",
"date_out_of_production_since": "2026-01-14T07:01:56.438766+00:00",
"date_end_support": "2026-01-14T07:01:56.438766+00:00",
"sales_organization_id": "278aac28-81c9-4278-bd0d-2126e67d5e3f",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "96acd54a-b06a-4688-8b6a-71d13e73ec9e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "37a0fef3-7543-4c2e-bd38-05e698c17141",
"db_currency_id": "47237842-8638-42d4-a3af-771ec989522e",
"db_language_id": "2575ba52-8811-429d-8c5b-7862df6ddd26",
"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-01-14T07:01:56.438766+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-01-14T07:01:56.438766+00:00"
},
"project_status_id": "f13f794e-38dd-4099-81c1-d3500d36bd09",
"project_status_code": "sample string 10",
"project_status": {
"id": "98fd16c1-a6c4-4583-9564-7dd1fd22307e",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "afba6417-0e5e-4e4e-9c6a-7c57a6538be2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "96acd54a-b06a-4688-8b6a-71d13e73ec9e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "37a0fef3-7543-4c2e-bd38-05e698c17141",
"db_currency_id": "47237842-8638-42d4-a3af-771ec989522e",
"db_language_id": "2575ba52-8811-429d-8c5b-7862df6ddd26",
"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-01-14T07:01:56.438766+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-14T07:01:56.438766+00:00"
},
"company_id": "d5a329b5-8def-444b-af32-3b6100115cb2",
"company_code": "sample string 12",
"db_address_id": "9fe231e5-ad59-4cb2-bb16-5df803181eb8",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "9334cbd3-6333-4c3a-bf83-5d243cf6f59b",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "5d7a2670-33a8-4b3e-9afe-a9408749520e",
"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-01-14T07:01:56.438766+00:00",
"date_create": "2026-01-14T07:01:56.438766+00:00",
"date_update": "2026-01-14T07:01:56.438766+00:00",
"updated_by_user_id": "542e6849-7a29-42cf-adc1-a3577b8d2ce4",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-14T07:01:56.438766+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-01-14T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-14T07:01:56.438766+00:00",
"date_last_job": "2026-01-14T07:01:56.438766+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-14T07:01:56.438766+00:00",
"modified_dateutc": "2026-01-14T07:01:56.438766+00:00",
"is_mobile_installation": true
},
"job_type_id": "02d519b1-a8b4-4bdb-8913-2447b583024e",
"job_type_code": "sample string 7",
"job_type": {
"id": "2fe28170-98bc-408a-bcc8-36d7f38c8634",
"name": "sample string 2",
"sales_organization_id": "28f9d072-ca8e-4b9f-8ad7-2d49a2c30f62",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-14T07:01:56.438766+00:00",
"code": "sample string 7"
},
"job_priority_id": "99435998-7496-4ef4-9f7a-9a75ef67fabc",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "68840fd3-d679-407b-82a4-a2e2c605db83",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "c54d1b5f-a437-4979-8bd9-f1e2b873d7cd",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "96acd54a-b06a-4688-8b6a-71d13e73ec9e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "37a0fef3-7543-4c2e-bd38-05e698c17141",
"db_currency_id": "47237842-8638-42d4-a3af-771ec989522e",
"db_language_id": "2575ba52-8811-429d-8c5b-7862df6ddd26",
"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-01-14T07:01:56.438766+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-14T07:01:56.438766+00:00"
},
"job_status_id": "8426a905-2651-4cc7-b5b3-6bdd353319a6",
"job_status_code": "sample string 11",
"db_address_id": "3f312dba-5d89-4016-a041-c5ea983bbc93",
"contact_id": "28529e46-7106-49df-9812-514eb1bb86ec",
"requested_by_company_id": "25a52f6c-0676-4ff7-a4bd-18c57f06c7d1",
"requested_by_contact_id": "d726285f-626c-4928-8448-5c3a143eea95",
"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-01-14T07:01:56.438766+00:00",
"due_date": "2026-01-14T07:01:56.438766+00:00",
"date_create": "2026-01-14T07:01:56.438766+00:00",
"date_update": "2026-01-14T07:01:56.438766+00:00",
"date_closed": "2026-01-14T07:01:56.438766+00:00",
"suggested_user_id": "ab633d96-f8ea-4d9e-9c47-518c9bad5e3e",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "a1ec1fac-ac1f-4fcf-9d8c-359d03521d83",
"db_language_id": "be90bd66-9fd0-486a-99ab-07e21c8cb846",
"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-01-14T07:01:56.438766+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "6f26aa4c-e31d-4449-80b1-f664429935de",
"sales_organization": {
"id": "96acd54a-b06a-4688-8b6a-71d13e73ec9e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "37a0fef3-7543-4c2e-bd38-05e698c17141",
"db_currency_id": "47237842-8638-42d4-a3af-771ec989522e",
"db_language_id": "2575ba52-8811-429d-8c5b-7862df6ddd26",
"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-01-14T07:01:56.438766+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "68439729-ebb4-4095-a11c-98cd7373dbe9",
"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": "e9d25ebd-8dd3-49f1-a292-8965744a9f21",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-14T07:01:56.438766+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "93039f97-4fb0-4201-bf0d-8393f38e359b"
},
"suggested_date_start": "2026-01-14T07:01:56.438766+00:00",
"skill_id": "38393e55-6313-4088-987f-ae97b0ed2f9d",
"skill_code": "sample string 32",
"skill": {
"id": "8c6c493c-1a74-4eb1-b8f8-a958d69bab88",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "4edd6158-1945-4109-8ef6-acb7484d046c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "96acd54a-b06a-4688-8b6a-71d13e73ec9e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "37a0fef3-7543-4c2e-bd38-05e698c17141",
"db_currency_id": "47237842-8638-42d4-a3af-771ec989522e",
"db_language_id": "2575ba52-8811-429d-8c5b-7862df6ddd26",
"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-01-14T07:01:56.438766+00:00"
},
"modified_dateutc": "2026-01-14T07:01:56.438766+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "31afed83-e088-45ff-bbc7-f8ffd9b353ed",
"date_reported_by_company": "2026-01-14T07:01:56.438766+00:00",
"id2": 36,
"company_id": "dfe77e1b-4b4b-49cb-a81a-0ccb43a386fc",
"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": "72e23e94-fdd6-4885-9995-560bf161bc26",
"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-01-14T07:01:56.438766+00:00"
},
"work_instruction_details_id": "dd1076b3-945a-4c5c-96be-7d52642a63ae",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "5512285b-a15e-4679-b085-fe628a38bf45",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "1f8619ed-2efb-4c14-baad-8cea700c9b5d",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-14T07:01:56.438766+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": "48235744-a25c-430e-9608-c0e06bee92c3",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-14T07:01:56.438766+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.