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": "06823f13-e9aa-424a-8c5d-8bb68c7de1a1",
"jobs_id": "fa0f4c62-ea1f-4f91-aacd-81e05c5b509a",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "20dca4e0-4d2f-49da-a49a-e33dbfcf67f5",
"_parent_id": "2831d5e5-6332-47e8-a73f-ff3f66f6f31c",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "50f75101-0a27-4b0d-a690-707e3dcce49a",
"project_reference_back_office": "sample string 5",
"project": {
"id": "9f33957d-6e6c-4e76-a425-b6eb96b8981e",
"_parent_id": "bb2ca74f-9c9f-4dca-aa7c-11dc380aae95",
"root_parent_id": "29dccc3b-fa44-40e4-b4c7-6a298bf6342a",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "40a0eafa-d074-4155-a0f6-25e4c85c6714",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "d65a1edb-34fc-422e-a54e-e5b8fc297d88",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "bc5e6f1f-1c7e-47dc-9937-2329c3679c51",
"_parent_code": "sample string 6",
"sales_organization_id": "2205af45-b02e-4197-95ca-ccf0ec1639d8",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "61f9ad7f-af31-4cb0-8586-650f3692c770",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d0a1e5d8-83cb-4d56-a694-af2cf2a2985b",
"db_currency_id": "c49c0d2d-6c8f-4908-8d9e-2d37cc6b0457",
"db_language_id": "e368dc8c-c9ae-4894-a400-aabd4af63647",
"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-18T13:53:28.9651988+00:00"
},
"modified_dateutc": "2025-11-18T13:53:28.9651988+00:00"
},
"equipment_model_id": "dd7b5af0-0405-410f-8d2b-09a0ed2bca40",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "139b191c-f02f-409e-9978-e9e9fbd04c74",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "756b7dff-8ca6-4d33-a7aa-d46d2382eb58",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "f86fa129-3a52-437d-8cf2-4ff55c954203",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "782615a6-e6d0-4466-8537-ac425b88ce4f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "61f9ad7f-af31-4cb0-8586-650f3692c770",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d0a1e5d8-83cb-4d56-a694-af2cf2a2985b",
"db_currency_id": "c49c0d2d-6c8f-4908-8d9e-2d37cc6b0457",
"db_language_id": "e368dc8c-c9ae-4894-a400-aabd4af63647",
"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-18T13:53:28.9651988+00:00"
},
"modified_dateutc": "2025-11-18T13:53:28.9651988+00:00"
},
"equipment_family_id": "1aae5e87-45fc-4259-8628-17505ea467e8",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "d65a1edb-34fc-422e-a54e-e5b8fc297d88",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "bc5e6f1f-1c7e-47dc-9937-2329c3679c51",
"_parent_code": "sample string 6",
"sales_organization_id": "2205af45-b02e-4197-95ca-ccf0ec1639d8",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "61f9ad7f-af31-4cb0-8586-650f3692c770",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d0a1e5d8-83cb-4d56-a694-af2cf2a2985b",
"db_currency_id": "c49c0d2d-6c8f-4908-8d9e-2d37cc6b0457",
"db_language_id": "e368dc8c-c9ae-4894-a400-aabd4af63647",
"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-18T13:53:28.9651988+00:00"
},
"modified_dateutc": "2025-11-18T13:53:28.9651988+00:00"
},
"date_in_production_since": "2025-11-18T13:53:28.9651988+00:00",
"date_out_of_production_since": "2025-11-18T13:53:28.9651988+00:00",
"date_end_support": "2025-11-18T13:53:28.9651988+00:00",
"sales_organization_id": "a947b424-9ace-4abc-94f6-b031c1d8b04b",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "61f9ad7f-af31-4cb0-8586-650f3692c770",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d0a1e5d8-83cb-4d56-a694-af2cf2a2985b",
"db_currency_id": "c49c0d2d-6c8f-4908-8d9e-2d37cc6b0457",
"db_language_id": "e368dc8c-c9ae-4894-a400-aabd4af63647",
"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-18T13:53:28.9651988+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-18T13:53:28.9651988+00:00"
},
"project_status_id": "5b05af09-a3fa-4b14-b821-669528665ece",
"project_status_code": "sample string 10",
"project_status": {
"id": "7feeede8-5a7e-47df-aec5-f714ff8428a8",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "18bfa409-c94b-495d-8038-378cb9076fd0",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "61f9ad7f-af31-4cb0-8586-650f3692c770",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d0a1e5d8-83cb-4d56-a694-af2cf2a2985b",
"db_currency_id": "c49c0d2d-6c8f-4908-8d9e-2d37cc6b0457",
"db_language_id": "e368dc8c-c9ae-4894-a400-aabd4af63647",
"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-18T13:53:28.9651988+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-18T13:53:28.9651988+00:00"
},
"company_id": "84fe6ab7-a035-4197-938e-7f05a2a71511",
"company_code": "sample string 12",
"db_address_id": "d9a5bec2-1287-472e-81e0-064b33197bc8",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "241670a9-a355-4692-b654-8f98c148c170",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "6919adb0-072a-45e3-a70e-ea53c09a9501",
"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-18T13:53:28.9651988+00:00",
"date_create": "2025-11-18T13:53:28.9651988+00:00",
"date_update": "2025-11-18T13:53:28.9651988+00:00",
"updated_by_user_id": "81e8c0a7-e66a-46bf-8c23-a6c799c470a6",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-18T13:53:28.9651988+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-18T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-11-18T13:53:28.9651988+00:00",
"date_last_job": "2025-11-18T13:53:28.9651988+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-18T13:53:28.9651988+00:00",
"modified_dateutc": "2025-11-18T13:53:28.9651988+00:00",
"is_mobile_installation": true
},
"job_type_id": "e04b1aa2-e259-4239-826a-3d2477913163",
"job_type_code": "sample string 7",
"job_type": {
"id": "a5aa26b3-d3fb-4b2a-bb40-0cf01a051a0e",
"name": "sample string 2",
"sales_organization_id": "5140c05a-03e6-457b-aa49-701bbb2c1c29",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-18T13:53:28.9651988+00:00",
"code": "sample string 7"
},
"job_priority_id": "71d7d4f8-252a-446f-b2b5-a10c28089d9d",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "2f13215b-9f6e-43e1-be8c-d2cb378d4ba5",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "2ad75b6b-17ea-423f-b7ef-a1d56b699be7",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "61f9ad7f-af31-4cb0-8586-650f3692c770",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d0a1e5d8-83cb-4d56-a694-af2cf2a2985b",
"db_currency_id": "c49c0d2d-6c8f-4908-8d9e-2d37cc6b0457",
"db_language_id": "e368dc8c-c9ae-4894-a400-aabd4af63647",
"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-18T13:53:28.9651988+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-18T13:53:28.9651988+00:00"
},
"job_status_id": "8317a743-30e6-4c0d-8eb5-2014203fc72a",
"job_status_code": "sample string 11",
"db_address_id": "4d5be4b0-d79a-46d5-afe1-b95fb3e39ebe",
"contact_id": "45a35a86-e705-48ba-b518-c60cebef414f",
"requested_by_company_id": "4535efb2-4949-41b2-9b22-5652c815b4e8",
"requested_by_contact_id": "b32fe1ff-23dc-4fe1-aefb-8ec0cdb42e4b",
"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-18T13:53:28.9651988+00:00",
"due_date": "2025-11-18T13:53:28.9651988+00:00",
"date_create": "2025-11-18T13:53:28.9651988+00:00",
"date_update": "2025-11-18T13:53:28.9651988+00:00",
"date_closed": "2025-11-18T13:53:28.9651988+00:00",
"suggested_user_id": "d5567fca-2032-4500-8472-af39eeb40bb2",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "8a7bfa61-3c0b-4ec0-ba6b-09aa3c156c26",
"db_language_id": "b02afabd-638e-4828-b3b7-a5a1cede4eda",
"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-18T13:53:28.9651988+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "8065ebe1-73a4-41f0-afaf-7a42a92027b1",
"sales_organization": {
"id": "61f9ad7f-af31-4cb0-8586-650f3692c770",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d0a1e5d8-83cb-4d56-a694-af2cf2a2985b",
"db_currency_id": "c49c0d2d-6c8f-4908-8d9e-2d37cc6b0457",
"db_language_id": "e368dc8c-c9ae-4894-a400-aabd4af63647",
"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-18T13:53:28.9651988+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "4db9b9ec-c3ed-4247-a1ba-ac29430d32b9",
"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": "1a0ed0eb-ee0e-42f2-a9a3-dc554673d0bf",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-18T13:53:28.9651988+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "300ae86b-7337-4b26-aa81-b9971eeb4b9e"
},
"suggested_date_start": "2025-11-18T13:53:28.9651988+00:00",
"skill_id": "a9d124b5-d2f4-4a83-8def-27508397c36a",
"skill_code": "sample string 32",
"skill": {
"id": "ae8f5e54-4844-48af-8e8c-d6b233cbf014",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "913a799e-eaf6-43f2-bac7-39b09e0cf52b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "61f9ad7f-af31-4cb0-8586-650f3692c770",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d0a1e5d8-83cb-4d56-a694-af2cf2a2985b",
"db_currency_id": "c49c0d2d-6c8f-4908-8d9e-2d37cc6b0457",
"db_language_id": "e368dc8c-c9ae-4894-a400-aabd4af63647",
"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-18T13:53:28.9651988+00:00"
},
"modified_dateutc": "2025-11-18T13:53:28.9651988+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "e3c33e08-1e06-4cb3-b3fd-a9cb627d7fa9",
"date_reported_by_company": "2025-11-18T13:53:28.9808237+00:00",
"id2": 36,
"company_id": "4d7550f1-f57a-48bc-bb87-ff8e005fbafa",
"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": "78bf1db7-aa8e-4d15-bdcf-0debe44b2206",
"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-18T13:53:28.9808237+00:00"
},
"work_instruction_details_id": "8cb6b024-d878-40b8-94de-a901f3cc0b99",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "a3169c31-0c67-4a40-8dc4-5883c2ee04c1",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "3d06fd6a-2f97-4420-901f-cbc1975f95ef",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-11-18T13:53:28.9808237+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": "e89983e6-f2ec-4789-b9ad-d4449f7f2483",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-11-18T13:53:28.9808237+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.