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": "24dd2d54-c759-4a10-bdbe-32c79242738a",
"jobs_id": "bb3b7bcf-2c49-4e70-bdb3-fde3c6561175",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "217cc4e5-b7fd-473a-b9b1-e31f6d8bdc0b",
"_parent_id": "00c9a8c9-6f70-48f2-8fb4-b12873942035",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "20106a82-c5bf-47c0-a602-45e4e6c0c8bb",
"project_reference_back_office": "sample string 5",
"project": {
"id": "ab4b40aa-38fc-4180-a3f6-276d9a7084c7",
"_parent_id": "c0170373-d00c-4e8e-8ab3-13073e189926",
"root_parent_id": "a5da0c52-5e3c-4c7c-be15-924d43c8ae99",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "68298da4-6c87-4c8c-a88d-42151a155472",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "520a22e7-7df8-417a-8a9c-bbd0439e961a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "fc9a68e9-969c-458c-9930-8897a6263c7f",
"_parent_code": "sample string 6",
"sales_organization_id": "53feea45-f7ba-4220-9b03-cfaddeff5fda",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4d0383fc-083c-4e86-b343-42e0ac1c3c51",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d43eede9-8142-44d3-b392-3761e4c8b2e0",
"db_currency_id": "4aa5e33e-081a-4227-8a26-18010ccafc13",
"db_language_id": "608c8fb0-b8c8-4c3b-8570-2861e5158a13",
"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": "2025-11-07T23:24:41.0001728+00:00"
},
"modified_dateutc": "2025-11-07T23:24:41.0001728+00:00"
},
"equipment_model_id": "c43b0fdc-9a7e-4a90-9590-f08d70fad915",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "a1e079d8-0dcc-47aa-beb7-4f5b1559be5d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "40aeac0a-4ae8-4b65-8e40-5796e6c1e7bc",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "1b05f036-9142-42d1-97df-4539c5c02b49",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "6852c800-ef92-40cc-bd7d-40f8b1f352ca",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4d0383fc-083c-4e86-b343-42e0ac1c3c51",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d43eede9-8142-44d3-b392-3761e4c8b2e0",
"db_currency_id": "4aa5e33e-081a-4227-8a26-18010ccafc13",
"db_language_id": "608c8fb0-b8c8-4c3b-8570-2861e5158a13",
"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": "2025-11-07T23:24:41.0001728+00:00"
},
"modified_dateutc": "2025-11-07T23:24:41.0001728+00:00"
},
"equipment_family_id": "2a44cf6f-e7d9-48a7-81c8-a323a2450c82",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "520a22e7-7df8-417a-8a9c-bbd0439e961a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "fc9a68e9-969c-458c-9930-8897a6263c7f",
"_parent_code": "sample string 6",
"sales_organization_id": "53feea45-f7ba-4220-9b03-cfaddeff5fda",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4d0383fc-083c-4e86-b343-42e0ac1c3c51",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d43eede9-8142-44d3-b392-3761e4c8b2e0",
"db_currency_id": "4aa5e33e-081a-4227-8a26-18010ccafc13",
"db_language_id": "608c8fb0-b8c8-4c3b-8570-2861e5158a13",
"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": "2025-11-07T23:24:41.0001728+00:00"
},
"modified_dateutc": "2025-11-07T23:24:41.0001728+00:00"
},
"date_in_production_since": "2025-11-07T23:24:41.0001728+00:00",
"date_out_of_production_since": "2025-11-07T23:24:41.0001728+00:00",
"date_end_support": "2025-11-07T23:24:41.0001728+00:00",
"sales_organization_id": "11b54f05-a15c-4bcb-b04e-a78bb426f75f",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "4d0383fc-083c-4e86-b343-42e0ac1c3c51",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d43eede9-8142-44d3-b392-3761e4c8b2e0",
"db_currency_id": "4aa5e33e-081a-4227-8a26-18010ccafc13",
"db_language_id": "608c8fb0-b8c8-4c3b-8570-2861e5158a13",
"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": "2025-11-07T23:24:41.0001728+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": "2025-11-07T23:24:41.0001728+00:00"
},
"project_status_id": "038e6bd7-5b86-4703-ae8c-9a864d892f88",
"project_status_code": "sample string 10",
"project_status": {
"id": "5901fe9c-fa58-4d70-b2e3-e295b152d0f1",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "ff04f05b-9ca0-4b88-9ed7-945f9a7b78cf",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4d0383fc-083c-4e86-b343-42e0ac1c3c51",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d43eede9-8142-44d3-b392-3761e4c8b2e0",
"db_currency_id": "4aa5e33e-081a-4227-8a26-18010ccafc13",
"db_language_id": "608c8fb0-b8c8-4c3b-8570-2861e5158a13",
"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": "2025-11-07T23:24:41.0001728+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-07T23:24:41.0001728+00:00"
},
"company_id": "5524149a-9cd6-48c4-a48a-fa1ce177511b",
"company_code": "sample string 12",
"db_address_id": "d04bc5dd-2d1e-4094-97a6-b7d39188fb90",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "6e31a7ea-81ed-4b62-853c-7b92b6ba803c",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "1dc4cc12-aeb2-479b-b002-4fa42b78c7df",
"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": "2025-11-07T23:24:41.0001728+00:00",
"date_create": "2025-11-07T23:24:41.0001728+00:00",
"date_update": "2025-11-07T23:24:41.0001728+00:00",
"updated_by_user_id": "f38634e2-b70b-43f9-9eb1-769d80388f6e",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-07T23:24:41.0001728+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": "2025-11-07T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-11-07T23:24:41.0001728+00:00",
"date_last_job": "2025-11-07T23:24:41.0001728+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-07T23:24:41.0001728+00:00",
"modified_dateutc": "2025-11-07T23:24:41.0001728+00:00",
"is_mobile_installation": true
},
"job_type_id": "28176846-e053-40b4-888a-e087439836dc",
"job_type_code": "sample string 7",
"job_type": {
"id": "51e889f5-7115-4c86-a523-7dc15f635d32",
"name": "sample string 2",
"sales_organization_id": "0415972f-9b35-4071-82da-3b40f4613989",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-07T23:24:41.0001728+00:00",
"code": "sample string 7"
},
"job_priority_id": "de5274d5-eb61-463d-8689-36c2cd142916",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "c3428740-8aa7-403a-8e96-8fc7402525f3",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "de01d5cc-f565-4d9d-9970-ff919104daef",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4d0383fc-083c-4e86-b343-42e0ac1c3c51",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d43eede9-8142-44d3-b392-3761e4c8b2e0",
"db_currency_id": "4aa5e33e-081a-4227-8a26-18010ccafc13",
"db_language_id": "608c8fb0-b8c8-4c3b-8570-2861e5158a13",
"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": "2025-11-07T23:24:41.0001728+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-07T23:24:41.0001728+00:00"
},
"job_status_id": "4f0cb79f-631f-4b19-ae73-2058eafbae6b",
"job_status_code": "sample string 11",
"db_address_id": "b89017fa-d1fc-4dca-ae5f-a63371f94c08",
"contact_id": "b711d63b-71d9-465d-adc9-0f0cc9569aa6",
"requested_by_company_id": "7d801af6-ecdf-4bbc-a0a0-144a8067017e",
"requested_by_contact_id": "c64f8bbf-0106-48f8-97cb-746693109c88",
"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": "2025-11-07T23:24:41.0001728+00:00",
"due_date": "2025-11-07T23:24:41.0001728+00:00",
"date_create": "2025-11-07T23:24:41.0001728+00:00",
"date_update": "2025-11-07T23:24:41.0001728+00:00",
"date_closed": "2025-11-07T23:24:41.0001728+00:00",
"suggested_user_id": "a6351d4d-35bf-45b8-81b0-3739557e8157",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "6201b9ef-fe0c-4e1b-97d8-703416778c37",
"db_language_id": "cf45f947-095e-4be2-b1c9-0463f0747385",
"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": "2025-11-07T23:24:41.0001728+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "c8574712-b905-43e9-9a25-8ea74454ec2c",
"sales_organization": {
"id": "4d0383fc-083c-4e86-b343-42e0ac1c3c51",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d43eede9-8142-44d3-b392-3761e4c8b2e0",
"db_currency_id": "4aa5e33e-081a-4227-8a26-18010ccafc13",
"db_language_id": "608c8fb0-b8c8-4c3b-8570-2861e5158a13",
"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": "2025-11-07T23:24:41.0001728+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "8dfd4424-7d6d-444e-b2c0-62b7ef498ddd",
"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": "d92a33fc-31cc-4c20-b387-857718be44a0",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-07T23:24:41.0157998+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "f500df36-0e63-4c9a-9d5f-f396f953aca8"
},
"suggested_date_start": "2025-11-07T23:24:41.0157998+00:00",
"skill_id": "adfa5de9-bb7b-4e7d-9b2e-213f13b4b893",
"skill_code": "sample string 32",
"skill": {
"id": "9eacfbb0-6066-4e18-915c-580e6cc200c2",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "12a3d9b4-0ee7-483d-afa2-ba534dcb9b5c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4d0383fc-083c-4e86-b343-42e0ac1c3c51",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d43eede9-8142-44d3-b392-3761e4c8b2e0",
"db_currency_id": "4aa5e33e-081a-4227-8a26-18010ccafc13",
"db_language_id": "608c8fb0-b8c8-4c3b-8570-2861e5158a13",
"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": "2025-11-07T23:24:41.0001728+00:00"
},
"modified_dateutc": "2025-11-07T23:24:41.0157998+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "1b52c66d-82eb-4b0b-a4a3-69985f3b8b91",
"date_reported_by_company": "2025-11-07T23:24:41.0157998+00:00",
"id2": 36,
"company_id": "598259d6-1790-4d18-92c6-51e96c4eb385",
"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": "fffe46b6-fd1d-4b6a-88fd-cacae217fdd2",
"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": "2025-11-07T23:24:41.0157998+00:00"
},
"work_instruction_details_id": "bc7887cf-5cce-44ed-8f6f-6173031da98e",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "8abf7f3e-1ccd-4f2a-a456-8650d836c872",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "a2a440b7-b1e5-422a-a2e3-f98db4f8d3f6",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-11-07T23:24:41.0157998+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": "98d2cb7d-a487-4f2c-9eed-4617af49f2e5",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-11-07T23:24:41.0157998+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.