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": "15c4c420-ca67-4c9d-b03a-8ffc5498038b",
"jobs_id": "2f2296a2-db99-4f5b-b054-1a9065083151",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "3ea5802c-956f-4cb9-8bb1-c69c9679c740",
"_parent_id": "446f8590-b019-42fe-be0f-3b72eedd5cb0",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "4fa5e856-a6ad-4848-bb1e-7c99d1365195",
"project_reference_back_office": "sample string 5",
"project": {
"id": "da2f00cd-8a96-4632-8188-76bea28e2922",
"_parent_id": "b242f11f-9584-4f67-80b3-34298044e7a6",
"root_parent_id": "0ccb9d63-ecb4-476d-8ff4-f4eaaedb1d66",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "d17cf08c-3642-4b5f-b310-782cbe763d34",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "9d10c59e-69c7-4b55-8e28-decf3992ca9f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "95733f5b-a44f-4898-bdd7-90cfe6051a84",
"_parent_code": "sample string 6",
"sales_organization_id": "2fc01f2e-f66d-4076-b700-dd5fc08cebee",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "818529a5-fc5c-4806-9878-f13a7af91118",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4dda38e6-8bfb-4471-b6a5-a3a527fce833",
"db_currency_id": "c4362f3b-a611-434a-9c05-44446c620b0b",
"db_language_id": "d289c172-83e5-4f25-9984-ec864878b2f8",
"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-02-09T06:25:15.4513984+00:00"
},
"modified_dateutc": "2026-02-09T06:25:15.4513984+00:00"
},
"equipment_model_id": "7b01c2ff-672a-48da-a5eb-150be20e970b",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "543e36b9-d9b9-416b-bc0f-07db20c34edc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "1bf2126e-71dc-481b-a59a-8ef74a29c060",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "b0888b3c-3b5a-4689-94fa-b4341a2ba398",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "2fb2006e-3374-4e60-8961-c852054c070f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "818529a5-fc5c-4806-9878-f13a7af91118",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4dda38e6-8bfb-4471-b6a5-a3a527fce833",
"db_currency_id": "c4362f3b-a611-434a-9c05-44446c620b0b",
"db_language_id": "d289c172-83e5-4f25-9984-ec864878b2f8",
"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-02-09T06:25:15.4513984+00:00"
},
"modified_dateutc": "2026-02-09T06:25:15.4513984+00:00"
},
"equipment_family_id": "d232291b-6bbd-4d13-ac90-300a3f00bdd9",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "9d10c59e-69c7-4b55-8e28-decf3992ca9f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "95733f5b-a44f-4898-bdd7-90cfe6051a84",
"_parent_code": "sample string 6",
"sales_organization_id": "2fc01f2e-f66d-4076-b700-dd5fc08cebee",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "818529a5-fc5c-4806-9878-f13a7af91118",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4dda38e6-8bfb-4471-b6a5-a3a527fce833",
"db_currency_id": "c4362f3b-a611-434a-9c05-44446c620b0b",
"db_language_id": "d289c172-83e5-4f25-9984-ec864878b2f8",
"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-02-09T06:25:15.4513984+00:00"
},
"modified_dateutc": "2026-02-09T06:25:15.4513984+00:00"
},
"date_in_production_since": "2026-02-09T06:25:15.4513984+00:00",
"date_out_of_production_since": "2026-02-09T06:25:15.4513984+00:00",
"date_end_support": "2026-02-09T06:25:15.4513984+00:00",
"sales_organization_id": "5a027dec-97e3-4889-97c7-d15f0d7f1337",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "818529a5-fc5c-4806-9878-f13a7af91118",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4dda38e6-8bfb-4471-b6a5-a3a527fce833",
"db_currency_id": "c4362f3b-a611-434a-9c05-44446c620b0b",
"db_language_id": "d289c172-83e5-4f25-9984-ec864878b2f8",
"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-02-09T06:25:15.4513984+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-02-09T06:25:15.4513984+00:00"
},
"project_status_id": "681d3d9a-c6d5-4d47-982f-850df37dadc0",
"project_status_code": "sample string 10",
"project_status": {
"id": "92a8d6c1-805d-4113-8e92-5ec1a34b2991",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "b4dd8bb4-39c7-42a0-894d-93df63132ef5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "818529a5-fc5c-4806-9878-f13a7af91118",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4dda38e6-8bfb-4471-b6a5-a3a527fce833",
"db_currency_id": "c4362f3b-a611-434a-9c05-44446c620b0b",
"db_language_id": "d289c172-83e5-4f25-9984-ec864878b2f8",
"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-02-09T06:25:15.4513984+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-09T06:25:15.4513984+00:00"
},
"company_id": "2a6ad33b-73f4-408a-80a0-fb83feab9eb7",
"company_code": "sample string 12",
"db_address_id": "1f300042-3464-4b82-af08-77eac1867cb6",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "cb51634f-2687-4f0f-815c-5a9bea054a88",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "a4af05d4-1f84-45d0-b86e-fcb9a5d0723a",
"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-02-09T06:25:15.4513984+00:00",
"date_create": "2026-02-09T06:25:15.4513984+00:00",
"date_update": "2026-02-09T06:25:15.4513984+00:00",
"updated_by_user_id": "7ede4d21-c028-43db-8cdc-bb416172426e",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-02-09T06:25:15.4513984+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-02-09T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-02-09T06:25:15.4513984+00:00",
"date_last_job": "2026-02-09T06:25:15.4513984+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-02-09T06:25:15.4513984+00:00",
"modified_dateutc": "2026-02-09T06:25:15.4513984+00:00",
"is_mobile_installation": true
},
"job_type_id": "a00c5069-8382-4568-813b-22cf68d2e265",
"job_type_code": "sample string 7",
"job_type": {
"id": "686e6117-8fae-433d-8c6c-1d772608b933",
"name": "sample string 2",
"sales_organization_id": "134eceef-7d7e-40b9-8698-6148b8eb5bd6",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-02-09T06:25:15.4670259+00:00",
"code": "sample string 7"
},
"job_priority_id": "c67611be-985b-4942-864b-3f8238fc4f24",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "7a4abcee-5581-43b9-82d6-ec2a194b4e5c",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "0deaf909-3772-41b1-b045-e03f0a1e7e01",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "818529a5-fc5c-4806-9878-f13a7af91118",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4dda38e6-8bfb-4471-b6a5-a3a527fce833",
"db_currency_id": "c4362f3b-a611-434a-9c05-44446c620b0b",
"db_language_id": "d289c172-83e5-4f25-9984-ec864878b2f8",
"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-02-09T06:25:15.4513984+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-09T06:25:15.4670259+00:00"
},
"job_status_id": "9bbe54d2-6293-43c1-b431-75ba38f9515b",
"job_status_code": "sample string 11",
"db_address_id": "c79e8998-b9bf-4678-ada6-443652f221f2",
"contact_id": "69ff3303-8d4a-4b55-99c7-4ba1d3bc766b",
"requested_by_company_id": "1d99eb3f-4fb7-4201-8329-18c57d41635f",
"requested_by_contact_id": "c9f850e3-1ca2-4349-9136-c2a0000eb61f",
"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-02-09T06:25:15.4670259+00:00",
"due_date": "2026-02-09T06:25:15.4670259+00:00",
"date_create": "2026-02-09T06:25:15.4670259+00:00",
"date_update": "2026-02-09T06:25:15.4670259+00:00",
"date_closed": "2026-02-09T06:25:15.4670259+00:00",
"suggested_user_id": "3aae1533-cf07-43a6-890b-77933cfa2494",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "895a9ba7-05ae-4046-873a-3bd1e0f039bf",
"db_language_id": "c0a4617e-e805-4090-a5a4-8cb2ddc8db60",
"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-02-09T06:25:15.4670259+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "4b4a4ede-3dd7-4889-8863-fb5fbe7781fe",
"sales_organization": {
"id": "818529a5-fc5c-4806-9878-f13a7af91118",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4dda38e6-8bfb-4471-b6a5-a3a527fce833",
"db_currency_id": "c4362f3b-a611-434a-9c05-44446c620b0b",
"db_language_id": "d289c172-83e5-4f25-9984-ec864878b2f8",
"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-02-09T06:25:15.4513984+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "ea68a489-0696-46e7-b028-9de1259f1542",
"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": "84956ec5-1b02-406b-b4c3-d0b00013b1d2",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-02-09T06:25:15.4670259+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "f092f89a-bb50-4c09-a632-e15b3fbc0d21"
},
"suggested_date_start": "2026-02-09T06:25:15.4670259+00:00",
"skill_id": "a951c862-6569-4cae-9e7c-0663a6bf67dd",
"skill_code": "sample string 32",
"skill": {
"id": "855ecb7c-bf05-4139-8f80-49aab77a3d0c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "cb207550-e96f-4a31-85b0-9e9290c9633b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "818529a5-fc5c-4806-9878-f13a7af91118",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4dda38e6-8bfb-4471-b6a5-a3a527fce833",
"db_currency_id": "c4362f3b-a611-434a-9c05-44446c620b0b",
"db_language_id": "d289c172-83e5-4f25-9984-ec864878b2f8",
"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-02-09T06:25:15.4513984+00:00"
},
"modified_dateutc": "2026-02-09T06:25:15.4670259+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "e6d1ef34-4528-4f35-9348-8a5a35181fd0",
"date_reported_by_company": "2026-02-09T06:25:15.4670259+00:00",
"id2": 36,
"company_id": "d6439aa8-4526-4d58-b3f3-b098b6b787ff",
"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": "b1a39e92-9263-4e49-b39f-f82f94789f06",
"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-02-09T06:25:15.4670259+00:00"
},
"work_instruction_details_id": "de2c440c-ec73-41e6-8622-5617e3ec7204",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "349e7041-8f3a-4504-b255-68cd805d54b8",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "4245e688-a20b-4543-a73e-de21a3976d27",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-02-09T06:25:15.4670259+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": "a10b95fb-0190-4470-aae5-039deaf867c7",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-02-09T06:25:15.4670259+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.