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
{
"id": "7effa463-fef3-4b2b-8755-a4815015d8f8",
"jobs_id": "e6203bd8-e68a-4d61-bc2f-3914050db4aa",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "6e207e43-4c02-4e0f-ac93-85b98301c2af",
"_parent_id": "c321931d-e14d-4331-a939-aee8167e4b57",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "99b7c67d-22dd-41e6-b388-141a23215e5b",
"project_reference_back_office": "sample string 5",
"project": {
"id": "9085d337-fefb-492e-a862-bfb6fe53b465",
"_parent_id": "4f9b9103-1e06-4382-96c7-ffb12d1eddfb",
"root_parent_id": "4c9bd92c-a2c0-40cd-9ece-8ecfe0f1964f",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "1cfebab1-24af-42fa-8da4-035f1b5d28ae",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "54916f82-2526-4419-8b3e-671180d89c47",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "abd4412c-eaf7-450f-976f-b6317e58e329",
"_parent_code": "sample string 6",
"sales_organization_id": "ac51306b-8f12-4932-ab84-f6ee22594ded",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1129ee55-d619-40aa-b47a-d5b10ab7ab2c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9d4a0e9e-dca2-498b-a3cf-02a8ec146aa9",
"db_currency_id": "d0e53f83-29e5-47fe-a140-d18ecc12e4e9",
"db_language_id": "25b153aa-7038-4e87-b71d-8f9bf732a286",
"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-11-19T08:33:45.2326552+00:00"
},
"modified_dateutc": "2026-11-19T08:33:45.2326552+00:00"
},
"equipment_model_id": "c9b472d0-c03e-4cd9-9faf-fdb125cff8cd",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "f5e2e55e-c199-4fd2-842b-b13d1731098b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "e6999a0b-ff47-4776-bbf8-ec4f41da3a3d",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "56534c19-490f-4990-8a09-53078a14c134",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "d6819996-7d69-4f63-99ce-1167e71d3a80",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1129ee55-d619-40aa-b47a-d5b10ab7ab2c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9d4a0e9e-dca2-498b-a3cf-02a8ec146aa9",
"db_currency_id": "d0e53f83-29e5-47fe-a140-d18ecc12e4e9",
"db_language_id": "25b153aa-7038-4e87-b71d-8f9bf732a286",
"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-11-19T08:33:45.2326552+00:00"
},
"modified_dateutc": "2026-11-19T08:33:45.2326552+00:00"
},
"equipment_family_id": "512ef800-9f2a-46c0-9dd0-7595104b5be1",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "54916f82-2526-4419-8b3e-671180d89c47",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "abd4412c-eaf7-450f-976f-b6317e58e329",
"_parent_code": "sample string 6",
"sales_organization_id": "ac51306b-8f12-4932-ab84-f6ee22594ded",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1129ee55-d619-40aa-b47a-d5b10ab7ab2c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9d4a0e9e-dca2-498b-a3cf-02a8ec146aa9",
"db_currency_id": "d0e53f83-29e5-47fe-a140-d18ecc12e4e9",
"db_language_id": "25b153aa-7038-4e87-b71d-8f9bf732a286",
"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-11-19T08:33:45.2326552+00:00"
},
"modified_dateutc": "2026-11-19T08:33:45.2326552+00:00"
},
"date_in_production_since": "2026-11-19T08:33:45.2326552+00:00",
"date_out_of_production_since": "2026-11-19T08:33:45.2326552+00:00",
"date_end_support": "2026-11-19T08:33:45.2326552+00:00",
"sales_organization_id": "cacf952c-ad12-4d66-a9c1-8ddda5920dc7",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "1129ee55-d619-40aa-b47a-d5b10ab7ab2c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9d4a0e9e-dca2-498b-a3cf-02a8ec146aa9",
"db_currency_id": "d0e53f83-29e5-47fe-a140-d18ecc12e4e9",
"db_language_id": "25b153aa-7038-4e87-b71d-8f9bf732a286",
"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-11-19T08:33:45.2326552+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-11-19T08:33:45.2326552+00:00"
},
"project_status_id": "634e9f40-11b0-4071-b34e-48401d566ae6",
"project_status_code": "sample string 10",
"project_status": {
"id": "26ae325b-188f-40a1-b8c4-8a4446661d92",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "35eaac53-5837-446e-8541-15663d52e081",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1129ee55-d619-40aa-b47a-d5b10ab7ab2c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9d4a0e9e-dca2-498b-a3cf-02a8ec146aa9",
"db_currency_id": "d0e53f83-29e5-47fe-a140-d18ecc12e4e9",
"db_language_id": "25b153aa-7038-4e87-b71d-8f9bf732a286",
"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-11-19T08:33:45.2326552+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-19T08:33:45.2326552+00:00"
},
"company_id": "e9c30b11-b5fc-4ce3-a886-512088e37a38",
"company_code": "sample string 12",
"db_address_id": "11b79f69-ba20-4884-ae66-b18329b101bc",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "2adc13cc-4885-440b-9b40-2cf0613bb065",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "54706137-6ba7-484c-827e-500f2606bd7a",
"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-11-19T08:33:45.2326552+00:00",
"date_create": "2026-11-19T08:33:45.2326552+00:00",
"date_update": "2026-11-19T08:33:45.2326552+00:00",
"updated_by_user_id": "5e654fdb-7d8b-4df8-923b-adf75aa04afe",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-11-19T08:33:45.2326552+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-11-19T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-11-19T08:33:45.2326552+00:00",
"date_last_job": "2026-11-19T08:33:45.2326552+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-11-19T08:33:45.2326552+00:00",
"modified_dateutc": "2026-11-19T08:33:45.2326552+00:00",
"is_mobile_installation": true
},
"job_type_id": "135294ba-5851-441f-80dd-ed644d4a7382",
"job_type_code": "sample string 7",
"job_type": {
"id": "4e06e6ca-9f7d-44b1-8aa7-aee700949000",
"name": "sample string 2",
"sales_organization_id": "eb37946f-2ac0-4965-b275-1fff2104d747",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-11-19T08:33:45.2326552+00:00",
"code": "sample string 7"
},
"job_priority_id": "87aa5be8-5717-48df-b499-49685e5f9d60",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "ebc3e38d-396e-488c-a6ec-cc280df937d5",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "e1d30249-8177-4727-816a-75bcd96abb50",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1129ee55-d619-40aa-b47a-d5b10ab7ab2c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9d4a0e9e-dca2-498b-a3cf-02a8ec146aa9",
"db_currency_id": "d0e53f83-29e5-47fe-a140-d18ecc12e4e9",
"db_language_id": "25b153aa-7038-4e87-b71d-8f9bf732a286",
"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-11-19T08:33:45.2326552+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-19T08:33:45.2326552+00:00"
},
"job_status_id": "1b4baf89-cc10-4d26-a699-5ea1d0bb8d4e",
"job_status_code": "sample string 11",
"db_address_id": "daf8a310-0db6-490d-a86f-cf1486302c29",
"contact_id": "28b4e2b8-7baf-4c77-b83d-08342f4e7b7c",
"requested_by_company_id": "acf4183c-77b0-4082-8752-06ba27b07f2f",
"requested_by_contact_id": "44655df7-03ab-47d5-84e7-f0bf0f862359",
"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-11-19T08:33:45.2326552+00:00",
"due_date": "2026-11-19T08:33:45.2326552+00:00",
"date_create": "2026-11-19T08:33:45.2326552+00:00",
"date_update": "2026-11-19T08:33:45.2326552+00:00",
"date_closed": "2026-11-19T08:33:45.2326552+00:00",
"suggested_user_id": "32d2cdd4-725c-4b16-931b-3533822c1b88",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "e910513f-196e-4ce3-8f1e-fb068f7fdf71",
"db_language_id": "6fc121f8-3d9a-47e1-9223-1d0c5b5bc845",
"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-11-19T08:33:45.2326552+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "a071765f-22e1-48d4-a2da-6ca941c61f11",
"sales_organization": {
"id": "1129ee55-d619-40aa-b47a-d5b10ab7ab2c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9d4a0e9e-dca2-498b-a3cf-02a8ec146aa9",
"db_currency_id": "d0e53f83-29e5-47fe-a140-d18ecc12e4e9",
"db_language_id": "25b153aa-7038-4e87-b71d-8f9bf732a286",
"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-11-19T08:33:45.2326552+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "dbb77a32-ea8e-4320-8469-042a9c69afb2",
"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": "144cc140-3242-4cff-81c6-a614bde673e6",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-11-19T08:33:45.2326552+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "fa1c251c-83f3-4bf5-a488-b6e321800391"
},
"suggested_date_start": "2026-11-19T08:33:45.2326552+00:00",
"skill_id": "a3c0cfaa-bf71-4ec1-b20b-fc5095e45924",
"skill_code": "sample string 32",
"skill": {
"id": "1345580d-b83f-4b80-b3cc-4d8e6335c33c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "e38f2ae9-8290-4255-bba1-7426f27798dc",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1129ee55-d619-40aa-b47a-d5b10ab7ab2c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9d4a0e9e-dca2-498b-a3cf-02a8ec146aa9",
"db_currency_id": "d0e53f83-29e5-47fe-a140-d18ecc12e4e9",
"db_language_id": "25b153aa-7038-4e87-b71d-8f9bf732a286",
"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-11-19T08:33:45.2326552+00:00"
},
"modified_dateutc": "2026-11-19T08:33:45.2326552+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "47971815-f40b-49fe-adeb-03750161c5e6",
"date_reported_by_company": "2026-11-19T08:33:45.2326552+00:00",
"id2": 36,
"company_id": "f4fba81b-8ce5-4b8a-a3db-d360935e7481",
"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": "9ad40a05-55d5-434e-93b7-36333def5243",
"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-11-19T08:33:45.2326552+00:00"
},
"work_instruction_details_id": "583edeb7-0962-4d48-9a7f-a35f0b0f96c5",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "140dd8cc-a679-4831-9275-3cd8da424a90",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "572537fc-4f4a-4d4f-b1d3-9be1f70f1b65",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-11-19T08:33:45.2453162+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": "34fcc039-f8a7-4af2-9925-7898ef432c4b",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-11-19T08:33:45.2453162+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.