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": "f7b86aa3-47e0-4319-923e-ee48dd0c1114",
"jobs_id": "5362e9ef-13f7-4769-baf3-7be18ab31988",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "d530fe39-63c3-48a0-9eef-ed243c303003",
"_parent_id": "a970f686-b873-489d-bc01-8a40f16c18a7",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "481e2b90-ec11-4788-a926-be06f7a8758d",
"project_reference_back_office": "sample string 5",
"project": {
"id": "553d9546-ef2e-4672-b48b-d92ee80ed108",
"_parent_id": "fe5a238c-45af-4937-b0a0-b434ff1b81b7",
"root_parent_id": "c3ce9a58-d179-49d7-b05c-c8234898a2cb",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "6e202eb0-3925-4e90-9b99-9e999e270f54",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "50bf91ce-99c5-44ea-bb7d-f3d291baaecf",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "26ff4891-061e-4930-8581-22fc350274b0",
"_parent_code": "sample string 6",
"sales_organization_id": "fd12690d-0584-4bc7-ab53-201e8b9dbfb6",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "65727c60-9d3c-4261-b0d6-39c82ec29877",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "70aed11b-5f3e-43a9-ad5e-4c1474c63c11",
"db_currency_id": "f3fd3b73-f1dc-4533-9f86-2c166a764ebf",
"db_language_id": "64253dcd-296c-4b4a-a884-d2b3c1aa7a7e",
"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-28T16:00:11.378164+00:00"
},
"modified_dateutc": "2025-11-28T16:00:11.378164+00:00"
},
"equipment_model_id": "b4885bef-bbdb-41ca-a59c-83412a691395",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "becbd7f9-20d1-4ae9-aca8-a9ea716e5b0e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "a0926319-f1af-42fa-bf11-64fcda1ae0cb",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "8ddfba75-d87e-4f18-9207-1497a7287949",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "4e1e511c-c975-402b-85e6-2bbee767483d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "65727c60-9d3c-4261-b0d6-39c82ec29877",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "70aed11b-5f3e-43a9-ad5e-4c1474c63c11",
"db_currency_id": "f3fd3b73-f1dc-4533-9f86-2c166a764ebf",
"db_language_id": "64253dcd-296c-4b4a-a884-d2b3c1aa7a7e",
"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-28T16:00:11.378164+00:00"
},
"modified_dateutc": "2025-11-28T16:00:11.378164+00:00"
},
"equipment_family_id": "69afcadd-0504-4331-a148-2da0263870ee",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "50bf91ce-99c5-44ea-bb7d-f3d291baaecf",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "26ff4891-061e-4930-8581-22fc350274b0",
"_parent_code": "sample string 6",
"sales_organization_id": "fd12690d-0584-4bc7-ab53-201e8b9dbfb6",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "65727c60-9d3c-4261-b0d6-39c82ec29877",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "70aed11b-5f3e-43a9-ad5e-4c1474c63c11",
"db_currency_id": "f3fd3b73-f1dc-4533-9f86-2c166a764ebf",
"db_language_id": "64253dcd-296c-4b4a-a884-d2b3c1aa7a7e",
"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-28T16:00:11.378164+00:00"
},
"modified_dateutc": "2025-11-28T16:00:11.378164+00:00"
},
"date_in_production_since": "2025-11-28T16:00:11.378164+00:00",
"date_out_of_production_since": "2025-11-28T16:00:11.378164+00:00",
"date_end_support": "2025-11-28T16:00:11.378164+00:00",
"sales_organization_id": "ecb4c03f-afd2-4fc4-9d0e-5b9bba570b9c",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "65727c60-9d3c-4261-b0d6-39c82ec29877",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "70aed11b-5f3e-43a9-ad5e-4c1474c63c11",
"db_currency_id": "f3fd3b73-f1dc-4533-9f86-2c166a764ebf",
"db_language_id": "64253dcd-296c-4b4a-a884-d2b3c1aa7a7e",
"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-28T16:00:11.378164+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-28T16:00:11.378164+00:00"
},
"project_status_id": "20d6d4dc-c37e-481a-ad2c-fa687bdd0843",
"project_status_code": "sample string 10",
"project_status": {
"id": "2954ce40-b977-46c6-a93a-a94b4e7687bb",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "42744baf-cd2d-4863-9606-98d947eab7f2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "65727c60-9d3c-4261-b0d6-39c82ec29877",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "70aed11b-5f3e-43a9-ad5e-4c1474c63c11",
"db_currency_id": "f3fd3b73-f1dc-4533-9f86-2c166a764ebf",
"db_language_id": "64253dcd-296c-4b4a-a884-d2b3c1aa7a7e",
"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-28T16:00:11.378164+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-28T16:00:11.378164+00:00"
},
"company_id": "55f2d1e0-c37e-4af4-b22a-0bef7b401240",
"company_code": "sample string 12",
"db_address_id": "d566ad11-b195-4e07-a164-431d3d2cf10a",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "5f46cbfa-d36c-4f44-bead-5a4fa02cba2b",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "5b8751ec-8d44-4895-9275-683d0b599841",
"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-28T16:00:11.378164+00:00",
"date_create": "2025-11-28T16:00:11.378164+00:00",
"date_update": "2025-11-28T16:00:11.378164+00:00",
"updated_by_user_id": "ccc4b681-2814-4a52-96ff-ca25f680972d",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-28T16:00:11.378164+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-28T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-11-28T16:00:11.378164+00:00",
"date_last_job": "2025-11-28T16:00:11.378164+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-28T16:00:11.378164+00:00",
"modified_dateutc": "2025-11-28T16:00:11.378164+00:00",
"is_mobile_installation": true
},
"job_type_id": "23b8375c-cdfe-4301-b6ec-e7642c879b39",
"job_type_code": "sample string 7",
"job_type": {
"id": "3221ad37-8d9b-490f-953b-adb833cfddb4",
"name": "sample string 2",
"sales_organization_id": "0a4718c4-b937-486b-9905-afc251071e5f",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-28T16:00:11.378164+00:00",
"code": "sample string 7"
},
"job_priority_id": "77fcbdb1-40cc-48e8-91bd-68e0aa8178a1",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "4a3d91ec-8579-43c6-9bc2-275e7fe65fe8",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "a1aae3a7-cba6-4d24-9237-654c2cc420aa",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "65727c60-9d3c-4261-b0d6-39c82ec29877",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "70aed11b-5f3e-43a9-ad5e-4c1474c63c11",
"db_currency_id": "f3fd3b73-f1dc-4533-9f86-2c166a764ebf",
"db_language_id": "64253dcd-296c-4b4a-a884-d2b3c1aa7a7e",
"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-28T16:00:11.378164+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-28T16:00:11.378164+00:00"
},
"job_status_id": "45d8f0a0-521c-4b19-8fda-e993d5763f67",
"job_status_code": "sample string 11",
"db_address_id": "04e60784-973c-4607-a1ac-c900d99fbeb4",
"contact_id": "69ec6d97-5818-4052-bfa9-6d66a2b28dc2",
"requested_by_company_id": "16c22eb6-5440-427e-b539-cb9fd8ac44e6",
"requested_by_contact_id": "fcf81c1a-7184-461a-b52d-cddac1d2dae6",
"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-28T16:00:11.378164+00:00",
"due_date": "2025-11-28T16:00:11.378164+00:00",
"date_create": "2025-11-28T16:00:11.378164+00:00",
"date_update": "2025-11-28T16:00:11.378164+00:00",
"date_closed": "2025-11-28T16:00:11.378164+00:00",
"suggested_user_id": "b6a24e01-2daa-4571-9e8f-78268acae2cf",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "4eacfcb3-0d43-45d8-8673-35efe2ae8efe",
"db_language_id": "e658ef14-60b6-4b5e-ac51-c6a23219e62b",
"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-28T16:00:11.378164+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "0e9a4f06-94f2-452b-8ffe-37357aeaaec6",
"sales_organization": {
"id": "65727c60-9d3c-4261-b0d6-39c82ec29877",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "70aed11b-5f3e-43a9-ad5e-4c1474c63c11",
"db_currency_id": "f3fd3b73-f1dc-4533-9f86-2c166a764ebf",
"db_language_id": "64253dcd-296c-4b4a-a884-d2b3c1aa7a7e",
"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-28T16:00:11.378164+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "ac5c0129-0e17-44b6-a3d1-caafa24227e3",
"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": "12b5a6d2-d4dc-4d7f-98ab-063b33ecf35d",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-28T16:00:11.378164+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "0199fa80-4a51-4b4b-b8ca-727de932ec6b"
},
"suggested_date_start": "2025-11-28T16:00:11.378164+00:00",
"skill_id": "9f24d436-12bf-4f29-8d68-2f6c4ab51f6a",
"skill_code": "sample string 32",
"skill": {
"id": "a8ec8088-53f9-4d98-904b-cfba143ba5f7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "08f20e32-e327-4e15-a78c-e67f06142084",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "65727c60-9d3c-4261-b0d6-39c82ec29877",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "70aed11b-5f3e-43a9-ad5e-4c1474c63c11",
"db_currency_id": "f3fd3b73-f1dc-4533-9f86-2c166a764ebf",
"db_language_id": "64253dcd-296c-4b4a-a884-d2b3c1aa7a7e",
"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-28T16:00:11.378164+00:00"
},
"modified_dateutc": "2025-11-28T16:00:11.378164+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "b7bd0197-49c4-4bd2-9972-255c9b351b03",
"date_reported_by_company": "2025-11-28T16:00:11.378164+00:00",
"id2": 36,
"company_id": "4d55cacc-0eaa-41bf-a8e5-8356e1a60616",
"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": "ff1ab48b-5173-48cb-9d39-ac256fffa83b",
"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-28T16:00:11.378164+00:00"
},
"work_instruction_details_id": "fb2a2e70-cee3-4918-9c7e-727ec189ce5f",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "d6abbe68-f568-4a15-a9b5-f2d3f56e2005",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "011718b7-5198-4a87-a598-2e74a26f18d7",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-11-28T16:00:11.378164+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": "c16dcd5b-e07d-4a7e-879d-b7279e8a3c78",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-11-28T16:00:11.378164+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.