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": "77ce4d39-2560-41bd-a1b2-573be46c98f7",
"jobs_id": "b7c7a7e6-8148-4bc2-8f10-5d373b07a5b4",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "d3668753-fafa-433a-967e-8b0d42c7af45",
"_parent_id": "8061b31b-a968-45bd-b23b-ca2288eeab41",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "b801f15b-3d75-49a2-bb2f-36ba8dc6d3e0",
"project_reference_back_office": "sample string 5",
"project": {
"id": "71ef9ac0-50b3-49dd-985e-0e1d7291a95d",
"_parent_id": "c9f575b9-71b5-49e4-9547-dc4005af312e",
"root_parent_id": "8dfb2825-3030-4c33-aee9-3a6362dc7269",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "2fddd902-c87b-48e0-931c-5118a243e77f",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "b1e2abf7-da0b-4192-a707-73c32c0ee6a4",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "6179c221-4ac5-4a63-9102-ce6945151aa6",
"_parent_code": "sample string 6",
"sales_organization_id": "4852c5e6-1702-4c7f-9439-5d5686cf5a68",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "dec24b9c-6c9e-4cbe-b43e-b73cc04c2205",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "48d09788-123a-4133-aacd-40ce0f099518",
"db_currency_id": "3e4cf518-3360-4d16-aeea-08b398fd27be",
"db_language_id": "62506e7f-86a3-4ba3-9692-30fc078daf95",
"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-12-25T08:21:00.8734022+00:00"
},
"modified_dateutc": "2025-12-25T08:21:00.8734022+00:00"
},
"equipment_model_id": "5a62468a-586f-4010-ba4b-38744b101046",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "7deb002e-4b2b-4734-b6cf-948864dd686e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "5fcbd851-9304-4c81-b2a2-a89c6fe3f855",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "b7335d0c-1bd5-4384-afb2-5b829cbc245f",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "2d8e007a-f64c-4b51-a0c1-6f88d9d5849d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "dec24b9c-6c9e-4cbe-b43e-b73cc04c2205",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "48d09788-123a-4133-aacd-40ce0f099518",
"db_currency_id": "3e4cf518-3360-4d16-aeea-08b398fd27be",
"db_language_id": "62506e7f-86a3-4ba3-9692-30fc078daf95",
"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-12-25T08:21:00.8734022+00:00"
},
"modified_dateutc": "2025-12-25T08:21:00.8734022+00:00"
},
"equipment_family_id": "dd2559b6-aa4a-4b1f-8cea-b6949c38f173",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "b1e2abf7-da0b-4192-a707-73c32c0ee6a4",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "6179c221-4ac5-4a63-9102-ce6945151aa6",
"_parent_code": "sample string 6",
"sales_organization_id": "4852c5e6-1702-4c7f-9439-5d5686cf5a68",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "dec24b9c-6c9e-4cbe-b43e-b73cc04c2205",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "48d09788-123a-4133-aacd-40ce0f099518",
"db_currency_id": "3e4cf518-3360-4d16-aeea-08b398fd27be",
"db_language_id": "62506e7f-86a3-4ba3-9692-30fc078daf95",
"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-12-25T08:21:00.8734022+00:00"
},
"modified_dateutc": "2025-12-25T08:21:00.8734022+00:00"
},
"date_in_production_since": "2025-12-25T08:21:00.8734022+00:00",
"date_out_of_production_since": "2025-12-25T08:21:00.8734022+00:00",
"date_end_support": "2025-12-25T08:21:00.8890258+00:00",
"sales_organization_id": "fd49d1b2-2a1a-4ef4-8a86-6e5c51cd9507",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "dec24b9c-6c9e-4cbe-b43e-b73cc04c2205",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "48d09788-123a-4133-aacd-40ce0f099518",
"db_currency_id": "3e4cf518-3360-4d16-aeea-08b398fd27be",
"db_language_id": "62506e7f-86a3-4ba3-9692-30fc078daf95",
"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-12-25T08:21:00.8734022+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-12-25T08:21:00.8890258+00:00"
},
"project_status_id": "1b1062f7-7c23-4d6a-a53e-8d5588ad612a",
"project_status_code": "sample string 10",
"project_status": {
"id": "05cf1398-2b70-4f0b-a390-46132cb34233",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "e14d67dd-c9d0-4522-b35d-a728d54e9823",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "dec24b9c-6c9e-4cbe-b43e-b73cc04c2205",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "48d09788-123a-4133-aacd-40ce0f099518",
"db_currency_id": "3e4cf518-3360-4d16-aeea-08b398fd27be",
"db_language_id": "62506e7f-86a3-4ba3-9692-30fc078daf95",
"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-12-25T08:21:00.8734022+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-25T08:21:00.8890258+00:00"
},
"company_id": "c63f899a-bfb9-498e-8755-8ffddf34b581",
"company_code": "sample string 12",
"db_address_id": "c8dbb22d-83a4-4b21-aa94-bf00aa53abde",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "5e314a6a-1a62-4b9c-88b7-2ac324818457",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "d6670b02-f25e-4d23-85e9-3c33078d5a44",
"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-12-25T08:21:00.8890258+00:00",
"date_create": "2025-12-25T08:21:00.8890258+00:00",
"date_update": "2025-12-25T08:21:00.8890258+00:00",
"updated_by_user_id": "8bc4fed3-aa68-417a-ae10-34372dbacbbd",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-25T08:21:00.8890258+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-12-25T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-25T08:21:00.8890258+00:00",
"date_last_job": "2025-12-25T08:21:00.8890258+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-25T08:21:00.8890258+00:00",
"modified_dateutc": "2025-12-25T08:21:00.8890258+00:00",
"is_mobile_installation": true
},
"job_type_id": "d24277c9-6d82-4659-bc17-2808c67ae79c",
"job_type_code": "sample string 7",
"job_type": {
"id": "2253728a-7121-40ea-a443-b3f2b5d26301",
"name": "sample string 2",
"sales_organization_id": "e256b812-2cd2-4965-8939-66978f333395",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-25T08:21:00.8890258+00:00",
"code": "sample string 7"
},
"job_priority_id": "4a81bc25-13dd-400f-9345-9ab3019b2b46",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "21986697-7ba7-45db-a1a6-07ec56c9b558",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "8d6189cc-1b70-4576-b7da-4ed56a795585",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "dec24b9c-6c9e-4cbe-b43e-b73cc04c2205",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "48d09788-123a-4133-aacd-40ce0f099518",
"db_currency_id": "3e4cf518-3360-4d16-aeea-08b398fd27be",
"db_language_id": "62506e7f-86a3-4ba3-9692-30fc078daf95",
"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-12-25T08:21:00.8734022+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-25T08:21:00.8890258+00:00"
},
"job_status_id": "ccd74aa9-ceb2-433d-beb8-62a7e409c26b",
"job_status_code": "sample string 11",
"db_address_id": "573fe707-c1a0-4c94-847c-657cfaacdc0f",
"contact_id": "77bda9a7-176b-40de-8352-4fc6216f700f",
"requested_by_company_id": "904a143b-f0ab-484a-8a76-c822bf51d75e",
"requested_by_contact_id": "1ae7f1c4-f18d-4836-9e75-32018c939450",
"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-12-25T08:21:00.8890258+00:00",
"due_date": "2025-12-25T08:21:00.8890258+00:00",
"date_create": "2025-12-25T08:21:00.8890258+00:00",
"date_update": "2025-12-25T08:21:00.8890258+00:00",
"date_closed": "2025-12-25T08:21:00.8890258+00:00",
"suggested_user_id": "03e143ce-113a-4e51-8a53-172a54f6a5a0",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "6c3f81b0-ca92-45e1-b26d-d4fa7050bb99",
"db_language_id": "69cd564f-6970-4558-8117-669f92b51b71",
"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-12-25T08:21:00.8890258+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "a1914843-4f28-4524-a17b-9548c2796b68",
"sales_organization": {
"id": "dec24b9c-6c9e-4cbe-b43e-b73cc04c2205",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "48d09788-123a-4133-aacd-40ce0f099518",
"db_currency_id": "3e4cf518-3360-4d16-aeea-08b398fd27be",
"db_language_id": "62506e7f-86a3-4ba3-9692-30fc078daf95",
"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-12-25T08:21:00.8734022+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "5daef911-6a45-4839-91f2-55e0a9876eff",
"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": "bf24d9a2-b2e0-4933-a243-d595a06ab7ae",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-25T08:21:00.8890258+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "01dc6db6-d556-48e9-a02f-03bad760aa90"
},
"suggested_date_start": "2025-12-25T08:21:00.8890258+00:00",
"skill_id": "d0f09a7e-c1cd-4c47-8c76-d02a5281bbe1",
"skill_code": "sample string 32",
"skill": {
"id": "f4a7962e-786f-48e4-8920-2ee074315ab5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "d202da59-f908-4834-a0a6-ba028d285ad9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "dec24b9c-6c9e-4cbe-b43e-b73cc04c2205",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "48d09788-123a-4133-aacd-40ce0f099518",
"db_currency_id": "3e4cf518-3360-4d16-aeea-08b398fd27be",
"db_language_id": "62506e7f-86a3-4ba3-9692-30fc078daf95",
"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-12-25T08:21:00.8734022+00:00"
},
"modified_dateutc": "2025-12-25T08:21:00.8890258+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "fe076581-68ce-412e-bca2-2d19528e9a81",
"date_reported_by_company": "2025-12-25T08:21:00.8890258+00:00",
"id2": 36,
"company_id": "95cdfb67-000a-4621-87b1-28ccc1c36be5",
"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": "b329e275-6a26-40f8-942b-4445478a9bae",
"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-12-25T08:21:00.8890258+00:00"
},
"work_instruction_details_id": "d44be3b1-a3b3-4912-a4c7-1ab9044135d0",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "55fd3379-a34f-4f2a-9952-e5a66c356d44",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "8a97a09b-f962-4a01-bac7-38430d92a9cc",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-25T08:21:00.8890258+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": "9575d291-aa28-409d-a3bf-306e9afb050e",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-25T08:21:00.8890258+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.