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": "afc89c96-179f-4ea3-88e3-00f3f0f42adb",
"jobs_id": "ab3da381-bfea-41df-9598-2795d154b3f7",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "51e5725d-56ea-495a-8553-218cbdd866cc",
"_parent_id": "3eb78740-7d9e-45c3-a67a-efd9fa0d760e",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "33fde6ed-49f4-4f57-b04f-1aee396784cd",
"project_reference_back_office": "sample string 5",
"project": {
"id": "78b23d5b-3d1c-4213-9932-6096c8d2c31f",
"_parent_id": "152e5184-0b22-4634-9d3d-357d207888fa",
"root_parent_id": "d5624cee-07df-4dfd-ae87-6e519ec664f9",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "8685e080-8331-4871-83ae-1e3cbfb9ef9c",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "110c0716-9add-4ddc-b982-14f43665ef53",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "0ea80c99-dbe0-4aef-bcf3-714b7bed7d95",
"_parent_code": "sample string 6",
"sales_organization_id": "465e84aa-1b4c-4c27-aa37-0595ada178ab",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "11978ac6-5d7d-4021-b574-60ef4cc6694f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "be778346-b5db-47ea-8f43-77963bc7a051",
"db_currency_id": "822bd1e5-226a-4df3-ad24-ac0b8f09d898",
"db_language_id": "1d37df6e-47c0-4b94-b170-6b585e79dd9f",
"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-20T07:59:36.7735245+00:00"
},
"modified_dateutc": "2026-01-20T07:59:36.7735245+00:00"
},
"equipment_model_id": "3f1d1e4a-4bc5-40f8-852f-0cbe7f10e10c",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "1b879282-b4c1-4ce8-86af-dceef9031d27",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "b68644b4-feaf-4c1b-b658-078f40bdb7d4",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "e017d4fe-aa23-4f0e-beff-2dbe5cb8cb89",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "d9c3c981-7581-4f1d-baf8-481d107569c4",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "11978ac6-5d7d-4021-b574-60ef4cc6694f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "be778346-b5db-47ea-8f43-77963bc7a051",
"db_currency_id": "822bd1e5-226a-4df3-ad24-ac0b8f09d898",
"db_language_id": "1d37df6e-47c0-4b94-b170-6b585e79dd9f",
"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-20T07:59:36.7735245+00:00"
},
"modified_dateutc": "2026-01-20T07:59:36.7735245+00:00"
},
"equipment_family_id": "18e6e5b1-9e09-4ee5-83d5-0303261119f2",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "110c0716-9add-4ddc-b982-14f43665ef53",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "0ea80c99-dbe0-4aef-bcf3-714b7bed7d95",
"_parent_code": "sample string 6",
"sales_organization_id": "465e84aa-1b4c-4c27-aa37-0595ada178ab",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "11978ac6-5d7d-4021-b574-60ef4cc6694f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "be778346-b5db-47ea-8f43-77963bc7a051",
"db_currency_id": "822bd1e5-226a-4df3-ad24-ac0b8f09d898",
"db_language_id": "1d37df6e-47c0-4b94-b170-6b585e79dd9f",
"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-20T07:59:36.7735245+00:00"
},
"modified_dateutc": "2026-01-20T07:59:36.7735245+00:00"
},
"date_in_production_since": "2026-01-20T07:59:36.7735245+00:00",
"date_out_of_production_since": "2026-01-20T07:59:36.7735245+00:00",
"date_end_support": "2026-01-20T07:59:36.7735245+00:00",
"sales_organization_id": "d8893f75-377c-46b4-b5e9-ce9b9071d055",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "11978ac6-5d7d-4021-b574-60ef4cc6694f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "be778346-b5db-47ea-8f43-77963bc7a051",
"db_currency_id": "822bd1e5-226a-4df3-ad24-ac0b8f09d898",
"db_language_id": "1d37df6e-47c0-4b94-b170-6b585e79dd9f",
"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-20T07:59:36.7735245+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-20T07:59:36.7735245+00:00"
},
"project_status_id": "828ed2f6-5620-49e0-8b02-951f8ed1dd82",
"project_status_code": "sample string 10",
"project_status": {
"id": "cd4f497c-08b7-4807-8f10-ae2ef89a4975",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "384dce28-3b00-4ebc-a7f6-fc892f6fa470",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "11978ac6-5d7d-4021-b574-60ef4cc6694f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "be778346-b5db-47ea-8f43-77963bc7a051",
"db_currency_id": "822bd1e5-226a-4df3-ad24-ac0b8f09d898",
"db_language_id": "1d37df6e-47c0-4b94-b170-6b585e79dd9f",
"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-20T07:59:36.7735245+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-20T07:59:36.7735245+00:00"
},
"company_id": "70bb7190-8cf5-4d71-894d-66bd2bf5eb26",
"company_code": "sample string 12",
"db_address_id": "4856b152-4a01-4b74-813d-36a1744b933f",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "974c72fa-3d1c-4fe7-9802-23e1c63218b4",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "9f2914fb-a7bf-41cd-852b-ce1964a9a944",
"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-20T07:59:36.7735245+00:00",
"date_create": "2026-01-20T07:59:36.7735245+00:00",
"date_update": "2026-01-20T07:59:36.7735245+00:00",
"updated_by_user_id": "deb56731-ddfd-4caf-90e6-a969368cc09d",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-20T07:59:36.7735245+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-20T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-20T07:59:36.7735245+00:00",
"date_last_job": "2026-01-20T07:59:36.7735245+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-20T07:59:36.7735245+00:00",
"modified_dateutc": "2026-01-20T07:59:36.7735245+00:00",
"is_mobile_installation": true
},
"job_type_id": "c5c04bdc-ff73-4bb1-bea5-de5239caf0ca",
"job_type_code": "sample string 7",
"job_type": {
"id": "ba81590f-216a-4e47-a2f7-8742cac6e69b",
"name": "sample string 2",
"sales_organization_id": "f6e4bea5-61fe-439f-b6b9-42c5813680b8",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-20T07:59:36.7735245+00:00",
"code": "sample string 7"
},
"job_priority_id": "06e81b19-4102-4bb9-a4e6-a03c64c7aa7c",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "7d2da72b-67e0-4092-8d57-4068932fda07",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "091fa05c-a285-407d-ae19-514ef1cdbb84",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "11978ac6-5d7d-4021-b574-60ef4cc6694f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "be778346-b5db-47ea-8f43-77963bc7a051",
"db_currency_id": "822bd1e5-226a-4df3-ad24-ac0b8f09d898",
"db_language_id": "1d37df6e-47c0-4b94-b170-6b585e79dd9f",
"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-20T07:59:36.7735245+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-20T07:59:36.7735245+00:00"
},
"job_status_id": "5d8e5790-27c6-42b2-ac62-d3cba61ac351",
"job_status_code": "sample string 11",
"db_address_id": "be7777c8-ba13-4e26-bbcf-8df5e75bc985",
"contact_id": "e30efd43-1625-42ac-b33c-75f5cddce4f9",
"requested_by_company_id": "7b60d07a-3ab1-4b92-a4f7-5885c8c3fc2d",
"requested_by_contact_id": "9824d900-b033-4246-9390-5aa661418d9d",
"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-20T07:59:36.7891491+00:00",
"due_date": "2026-01-20T07:59:36.7891491+00:00",
"date_create": "2026-01-20T07:59:36.7891491+00:00",
"date_update": "2026-01-20T07:59:36.7891491+00:00",
"date_closed": "2026-01-20T07:59:36.7891491+00:00",
"suggested_user_id": "2c4fda3e-3b6b-4b30-ad7e-7010f6a37e99",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "1196552e-1452-47df-b782-2ef5a09a10d8",
"db_language_id": "3759d5f1-b6e0-4caf-a4ce-301d29009a78",
"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-20T07:59:36.7891491+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "80175e3d-3972-486f-b90d-a93243148018",
"sales_organization": {
"id": "11978ac6-5d7d-4021-b574-60ef4cc6694f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "be778346-b5db-47ea-8f43-77963bc7a051",
"db_currency_id": "822bd1e5-226a-4df3-ad24-ac0b8f09d898",
"db_language_id": "1d37df6e-47c0-4b94-b170-6b585e79dd9f",
"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-20T07:59:36.7735245+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "564c88bf-e005-4694-b3f5-a7509cce5229",
"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": "a2699bca-dddb-4d10-9357-e32e2e163e37",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-20T07:59:36.7891491+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "0608917b-2cd8-4669-8877-15348b2db52f"
},
"suggested_date_start": "2026-01-20T07:59:36.7891491+00:00",
"skill_id": "639990b5-6da6-46a8-95f4-21a5ae98595f",
"skill_code": "sample string 32",
"skill": {
"id": "74671889-bdac-4167-9efc-867ea8601885",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "9788328a-7e7f-4264-bc05-8cb890565f5d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "11978ac6-5d7d-4021-b574-60ef4cc6694f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "be778346-b5db-47ea-8f43-77963bc7a051",
"db_currency_id": "822bd1e5-226a-4df3-ad24-ac0b8f09d898",
"db_language_id": "1d37df6e-47c0-4b94-b170-6b585e79dd9f",
"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-20T07:59:36.7735245+00:00"
},
"modified_dateutc": "2026-01-20T07:59:36.7891491+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "e71664dc-eaf2-462f-99ce-08f6f06ce62f",
"date_reported_by_company": "2026-01-20T07:59:36.7891491+00:00",
"id2": 36,
"company_id": "154550d8-14ba-4952-8ed6-761451171521",
"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": "23a8f710-c9b1-424d-9c01-9c02486820a3",
"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-20T07:59:36.7891491+00:00"
},
"work_instruction_details_id": "837a06c4-8e5d-4f6f-b103-2d811cafb074",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "a57a8a89-1001-4d35-817f-13cdfd1bc9e9",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "959c4dbe-6448-4f1c-88cc-25e61646bbb8",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-20T07:59:36.7891491+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": "60c285b2-f1cd-4a1d-b413-220676aaee5d",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-20T07:59:36.7891491+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.