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": "ff50a787-54ff-4393-aa91-5044fa932483",
"jobs_id": "c8807689-f665-418c-a351-d1d5227c0c07",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "f88d0eb1-bb4c-47d5-ac07-f4baec1ed140",
"_parent_id": "05e71e0a-2c10-42f7-9d5a-a3292e682303",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "bc803584-303d-4d52-97cf-6895f5c1bb38",
"project_reference_back_office": "sample string 5",
"project": {
"id": "514fdba3-2756-42a4-973c-9b48715bb9fa",
"_parent_id": "131e01d6-c4f4-4480-9c33-46587d530eda",
"root_parent_id": "ceec277f-11d2-4887-b490-5297e9db906c",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "2b761601-8602-4f10-b6d8-1fd740925fcf",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "6821a586-5741-4665-a697-c0eeaafeee88",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "84f5d0cb-b143-4a06-bdfe-f5de1a52e077",
"_parent_code": "sample string 6",
"sales_organization_id": "f35a6583-a463-4955-ae1c-882be9fcce7a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b0941c16-e29e-4808-8dae-efe8743d1987",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e255753d-dbe1-4af9-a4cb-cba8d9a35984",
"db_currency_id": "984dedb0-0899-4af5-8f73-30abbbb19bf4",
"db_language_id": "5e48bcc1-527b-4107-b1b1-e5c4525d26e0",
"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-05-20T04:30:12.7169243+00:00"
},
"modified_dateutc": "2026-05-20T04:30:12.7169243+00:00"
},
"equipment_model_id": "986cc8ab-cb61-489d-b568-56a229a474a6",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "b217bc98-f082-4ee0-a1e7-67faab8a5ec8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "b323eaaf-f66a-4dc8-8491-48e288b8d8c3",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "081b6f50-1630-4901-950d-21428ee5e56a",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "9ae98ee0-6cfb-4bb6-8884-88a0aeea2fe6",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b0941c16-e29e-4808-8dae-efe8743d1987",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e255753d-dbe1-4af9-a4cb-cba8d9a35984",
"db_currency_id": "984dedb0-0899-4af5-8f73-30abbbb19bf4",
"db_language_id": "5e48bcc1-527b-4107-b1b1-e5c4525d26e0",
"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-05-20T04:30:12.7169243+00:00"
},
"modified_dateutc": "2026-05-20T04:30:12.7169243+00:00"
},
"equipment_family_id": "20ffa436-40bd-4ba4-ba07-d099b714c874",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "6821a586-5741-4665-a697-c0eeaafeee88",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "84f5d0cb-b143-4a06-bdfe-f5de1a52e077",
"_parent_code": "sample string 6",
"sales_organization_id": "f35a6583-a463-4955-ae1c-882be9fcce7a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b0941c16-e29e-4808-8dae-efe8743d1987",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e255753d-dbe1-4af9-a4cb-cba8d9a35984",
"db_currency_id": "984dedb0-0899-4af5-8f73-30abbbb19bf4",
"db_language_id": "5e48bcc1-527b-4107-b1b1-e5c4525d26e0",
"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-05-20T04:30:12.7169243+00:00"
},
"modified_dateutc": "2026-05-20T04:30:12.7169243+00:00"
},
"date_in_production_since": "2026-05-20T04:30:12.7169243+00:00",
"date_out_of_production_since": "2026-05-20T04:30:12.7169243+00:00",
"date_end_support": "2026-05-20T04:30:12.7169243+00:00",
"sales_organization_id": "fd8bbeff-e810-43fb-8cce-e1ff1466b193",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "b0941c16-e29e-4808-8dae-efe8743d1987",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e255753d-dbe1-4af9-a4cb-cba8d9a35984",
"db_currency_id": "984dedb0-0899-4af5-8f73-30abbbb19bf4",
"db_language_id": "5e48bcc1-527b-4107-b1b1-e5c4525d26e0",
"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-05-20T04:30:12.7169243+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-05-20T04:30:12.7169243+00:00"
},
"project_status_id": "e7fe8dd5-f4b7-4fb9-b169-a77b47fb5fb5",
"project_status_code": "sample string 10",
"project_status": {
"id": "abd39ed5-bf26-4d1b-80f8-7199d4fabb9c",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "646d25cd-a752-4db0-9a87-3ed02b3cbf5e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b0941c16-e29e-4808-8dae-efe8743d1987",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e255753d-dbe1-4af9-a4cb-cba8d9a35984",
"db_currency_id": "984dedb0-0899-4af5-8f73-30abbbb19bf4",
"db_language_id": "5e48bcc1-527b-4107-b1b1-e5c4525d26e0",
"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-05-20T04:30:12.7169243+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-20T04:30:12.7169243+00:00"
},
"company_id": "08634117-a14e-4eb1-b7c7-19294fab7a91",
"company_code": "sample string 12",
"db_address_id": "bc06a740-9f89-42b4-8789-a37bff8fab5e",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "eb6d9d7e-40aa-42a5-80ab-23663fdb9d3d",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "041280fd-adfc-4f7b-af2a-f21de96892d6",
"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-05-20T04:30:12.7169243+00:00",
"date_create": "2026-05-20T04:30:12.7169243+00:00",
"date_update": "2026-05-20T04:30:12.7169243+00:00",
"updated_by_user_id": "55e6457b-a75d-4e83-810e-85db9771d3a6",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-20T04:30:12.7169243+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-05-20T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-20T04:30:12.7169243+00:00",
"date_last_job": "2026-05-20T04:30:12.7169243+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-20T04:30:12.7169243+00:00",
"modified_dateutc": "2026-05-20T04:30:12.7169243+00:00",
"is_mobile_installation": true
},
"job_type_id": "923e2a57-6ec3-4a2a-9d76-491f8c3c6c4c",
"job_type_code": "sample string 7",
"job_type": {
"id": "5efaa26f-6dd1-414d-abd3-364533c404d9",
"name": "sample string 2",
"sales_organization_id": "b4f04a59-b29c-473b-b6d5-abe153935850",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-20T04:30:12.7169243+00:00",
"code": "sample string 7"
},
"job_priority_id": "5a074725-d207-4cdb-9075-6788695adf19",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "4e345103-f05a-4271-b905-3a8771384d34",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "f0e29596-280a-4c42-a4ba-179ef16e3826",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b0941c16-e29e-4808-8dae-efe8743d1987",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e255753d-dbe1-4af9-a4cb-cba8d9a35984",
"db_currency_id": "984dedb0-0899-4af5-8f73-30abbbb19bf4",
"db_language_id": "5e48bcc1-527b-4107-b1b1-e5c4525d26e0",
"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-05-20T04:30:12.7169243+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-20T04:30:12.7169243+00:00"
},
"job_status_id": "e231a7ea-1309-4e54-8519-143194f7a707",
"job_status_code": "sample string 11",
"db_address_id": "35353d62-5dea-496a-9868-f86d43969191",
"contact_id": "67584f48-0432-4ec9-98c5-49d8231d2c35",
"requested_by_company_id": "8ce71e36-2f3c-4ea1-bbdb-a034006b4ca4",
"requested_by_contact_id": "28dc06db-c7f9-40e6-9f9c-0a50415b8581",
"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-05-20T04:30:12.7169243+00:00",
"due_date": "2026-05-20T04:30:12.7169243+00:00",
"date_create": "2026-05-20T04:30:12.7169243+00:00",
"date_update": "2026-05-20T04:30:12.7169243+00:00",
"date_closed": "2026-05-20T04:30:12.7169243+00:00",
"suggested_user_id": "518a8845-3dd7-415a-bd5b-0190b7e48559",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "5f115629-61e7-41d6-8ed4-23ec4615b3c3",
"db_language_id": "e89b4975-637e-43ef-aae6-74ddabd1d3ab",
"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-05-20T04:30:12.7169243+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "a35474fe-ac09-4c48-a452-653b5900e069",
"sales_organization": {
"id": "b0941c16-e29e-4808-8dae-efe8743d1987",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e255753d-dbe1-4af9-a4cb-cba8d9a35984",
"db_currency_id": "984dedb0-0899-4af5-8f73-30abbbb19bf4",
"db_language_id": "5e48bcc1-527b-4107-b1b1-e5c4525d26e0",
"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-05-20T04:30:12.7169243+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "e6bdf71c-036b-4b02-ab31-7713f595b7fd",
"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": "be3741f5-e5f0-449b-ad9d-b69c0cbb22a1",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-20T04:30:12.7169243+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "42f921d0-fb54-4ce1-b44e-daf460feaacc"
},
"suggested_date_start": "2026-05-20T04:30:12.7169243+00:00",
"skill_id": "cf106f9b-738b-4785-abd6-60f2e17cf96a",
"skill_code": "sample string 32",
"skill": {
"id": "90aaea0e-32cf-4e75-9de7-cba303a5b411",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "e02769b4-07b6-45f7-88aa-9c2cfe715017",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b0941c16-e29e-4808-8dae-efe8743d1987",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e255753d-dbe1-4af9-a4cb-cba8d9a35984",
"db_currency_id": "984dedb0-0899-4af5-8f73-30abbbb19bf4",
"db_language_id": "5e48bcc1-527b-4107-b1b1-e5c4525d26e0",
"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-05-20T04:30:12.7169243+00:00"
},
"modified_dateutc": "2026-05-20T04:30:12.7169243+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "cc3f5fcc-1680-49fb-b68d-c8b408970f49",
"date_reported_by_company": "2026-05-20T04:30:12.7169243+00:00",
"id2": 36,
"company_id": "fd39f07f-e061-4461-85e5-5291c1fc970d",
"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": "067a5555-9b89-4b5d-9789-aea2dcc50706",
"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-05-20T04:30:12.7169243+00:00"
},
"work_instruction_details_id": "2e690d95-9588-4fd5-840b-53727da77f11",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "08ad0d60-782a-45b1-b041-a3596ad09e62",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "698fbfeb-5d49-43c9-b9b9-32410ead1753",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-20T04:30:12.7169243+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": "ed69c6c2-7ad9-49ef-975f-ca17e5a1796b",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-20T04:30:12.7169243+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.