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": "01992f97-12ac-4b93-8028-5792d4d50263",
"jobs_id": "fc29c5d2-0c95-4dc9-8a34-4efa00877a7a",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "2251a30f-1b03-4251-b07a-456c3e006a6b",
"_parent_id": "35b870d1-e4f2-4272-9e23-6e34b1051088",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "1822ef2e-955c-491f-892f-ab871f85e89b",
"project_reference_back_office": "sample string 5",
"project": {
"id": "33791b7c-3478-4c7d-8f4b-6fa437b3e3f5",
"_parent_id": "cc467009-2e51-416f-8037-f9f40bd0489d",
"root_parent_id": "ca489955-78a4-41cc-ac45-c5fcd9c990d1",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "4c0b8d69-0aef-452d-a93e-3596156b270e",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "59cd5fb1-58a3-4641-83ac-6049d669d8da",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "24ce5183-2645-482f-bb24-57401fd4d008",
"_parent_code": "sample string 6",
"sales_organization_id": "7c6ce33a-9edb-448e-abae-e03c24a37299",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "663d2157-9d6a-4940-8ba3-d75550f7b9e5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "31e7acba-c026-4d43-a7b4-269ae62de0fa",
"db_currency_id": "5384396d-75e7-4b0b-846d-35cd160a920b",
"db_language_id": "79e6d1f3-1b42-4568-a5c2-01a52f216fbf",
"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-09-23T03:52:25.5542022+00:00"
},
"modified_dateutc": "2026-09-23T03:52:25.5542022+00:00"
},
"equipment_model_id": "df6a394c-2964-4664-aa70-3d9008c9eecd",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "fe05aa02-b5b5-4888-96dc-3cb213698556",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "3c7ec013-77b7-4ecb-a29b-5fd640f4caf7",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "4e59dd2b-bc50-41c6-8b0b-be27d90bb643",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "06385e25-36a6-4fca-b350-934356a9e4d1",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "663d2157-9d6a-4940-8ba3-d75550f7b9e5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "31e7acba-c026-4d43-a7b4-269ae62de0fa",
"db_currency_id": "5384396d-75e7-4b0b-846d-35cd160a920b",
"db_language_id": "79e6d1f3-1b42-4568-a5c2-01a52f216fbf",
"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-09-23T03:52:25.5542022+00:00"
},
"modified_dateutc": "2026-09-23T03:52:25.5542022+00:00"
},
"equipment_family_id": "c1f39a89-9d83-4bdf-9657-c4f6995b4e4e",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "59cd5fb1-58a3-4641-83ac-6049d669d8da",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "24ce5183-2645-482f-bb24-57401fd4d008",
"_parent_code": "sample string 6",
"sales_organization_id": "7c6ce33a-9edb-448e-abae-e03c24a37299",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "663d2157-9d6a-4940-8ba3-d75550f7b9e5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "31e7acba-c026-4d43-a7b4-269ae62de0fa",
"db_currency_id": "5384396d-75e7-4b0b-846d-35cd160a920b",
"db_language_id": "79e6d1f3-1b42-4568-a5c2-01a52f216fbf",
"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-09-23T03:52:25.5542022+00:00"
},
"modified_dateutc": "2026-09-23T03:52:25.5542022+00:00"
},
"date_in_production_since": "2026-09-23T03:52:25.5542022+00:00",
"date_out_of_production_since": "2026-09-23T03:52:25.5542022+00:00",
"date_end_support": "2026-09-23T03:52:25.5542022+00:00",
"sales_organization_id": "9c31071e-67cd-4064-94ce-91ac5cef5d78",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "663d2157-9d6a-4940-8ba3-d75550f7b9e5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "31e7acba-c026-4d43-a7b4-269ae62de0fa",
"db_currency_id": "5384396d-75e7-4b0b-846d-35cd160a920b",
"db_language_id": "79e6d1f3-1b42-4568-a5c2-01a52f216fbf",
"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-09-23T03:52:25.5542022+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-09-23T03:52:25.5542022+00:00"
},
"project_status_id": "d0e605c7-2dff-42bc-8287-eda31763eb22",
"project_status_code": "sample string 10",
"project_status": {
"id": "bbaf7839-3407-4ccc-a9a6-42f70c29232c",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "3cf17849-11c5-4dee-bed4-bbdb7bd530f4",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "663d2157-9d6a-4940-8ba3-d75550f7b9e5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "31e7acba-c026-4d43-a7b4-269ae62de0fa",
"db_currency_id": "5384396d-75e7-4b0b-846d-35cd160a920b",
"db_language_id": "79e6d1f3-1b42-4568-a5c2-01a52f216fbf",
"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-09-23T03:52:25.5542022+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-23T03:52:25.5542022+00:00"
},
"company_id": "e46c9191-b4d4-4212-b7e7-b3969edf3661",
"company_code": "sample string 12",
"db_address_id": "729c1fe6-22a5-48fb-8d73-a86cc4348c35",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "8f7e5797-5281-4040-a80a-082799c2802e",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "1b94d906-d54c-43f7-bc0a-d61eb3c3a3e1",
"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-09-23T03:52:25.5542022+00:00",
"date_create": "2026-09-23T03:52:25.5542022+00:00",
"date_update": "2026-09-23T03:52:25.5542022+00:00",
"updated_by_user_id": "89d66349-a147-4293-94b1-c711dcfb2b10",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-23T03:52:25.5542022+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-09-23T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-23T03:52:25.5542022+00:00",
"date_last_job": "2026-09-23T03:52:25.5542022+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-23T03:52:25.5542022+00:00",
"modified_dateutc": "2026-09-23T03:52:25.5542022+00:00",
"is_mobile_installation": true
},
"job_type_id": "52599c2f-2f2f-4020-adcb-1dc027aadbba",
"job_type_code": "sample string 7",
"job_type": {
"id": "62179fbd-f600-47ad-a93b-dc7156396dc1",
"name": "sample string 2",
"sales_organization_id": "d245fa3c-b167-4d66-96f7-741abae66dcb",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-23T03:52:25.5542022+00:00",
"code": "sample string 7"
},
"job_priority_id": "e836e381-1c2c-4268-a1fd-189ff48b9a82",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "2b97c6fe-a1e0-46b7-9401-18bcf7c242f1",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "b401f035-f947-42ba-8639-211f17b71b9d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "663d2157-9d6a-4940-8ba3-d75550f7b9e5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "31e7acba-c026-4d43-a7b4-269ae62de0fa",
"db_currency_id": "5384396d-75e7-4b0b-846d-35cd160a920b",
"db_language_id": "79e6d1f3-1b42-4568-a5c2-01a52f216fbf",
"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-09-23T03:52:25.5542022+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-23T03:52:25.5542022+00:00"
},
"job_status_id": "2b6efd07-813e-4467-bbd1-66f45b37def1",
"job_status_code": "sample string 11",
"db_address_id": "b09da0a7-96c4-4b19-8ce0-9a803d233926",
"contact_id": "a5d04c89-ca3d-47d8-863e-8a3ac7d75484",
"requested_by_company_id": "e6302065-0f52-4e60-8be0-84bd80c91b2a",
"requested_by_contact_id": "af47fa68-e38a-4b27-933d-f5e9d9664310",
"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-09-23T03:52:25.5542022+00:00",
"due_date": "2026-09-23T03:52:25.5542022+00:00",
"date_create": "2026-09-23T03:52:25.5542022+00:00",
"date_update": "2026-09-23T03:52:25.5542022+00:00",
"date_closed": "2026-09-23T03:52:25.5542022+00:00",
"suggested_user_id": "1a9a43a9-5e3a-4e06-bdfa-9d8a613ad165",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "b6919f3e-1bb0-484c-b4b0-91115b48bc17",
"db_language_id": "bbb372f2-7fcd-407c-8556-1db1ac5a00ba",
"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-09-23T03:52:25.5542022+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "d7da142e-1cec-4f72-99ee-4b8a3392774f",
"sales_organization": {
"id": "663d2157-9d6a-4940-8ba3-d75550f7b9e5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "31e7acba-c026-4d43-a7b4-269ae62de0fa",
"db_currency_id": "5384396d-75e7-4b0b-846d-35cd160a920b",
"db_language_id": "79e6d1f3-1b42-4568-a5c2-01a52f216fbf",
"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-09-23T03:52:25.5542022+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "e0157b0e-b877-4eb7-8a2b-a84926524020",
"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": "b46a2c52-5605-4227-b20f-85e498193ab5",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-23T03:52:25.5542022+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "ca4a4054-0473-4a10-8417-4bc98a097680"
},
"suggested_date_start": "2026-09-23T03:52:25.5542022+00:00",
"skill_id": "e512424f-711d-4ee8-88db-df1afec77195",
"skill_code": "sample string 32",
"skill": {
"id": "66c5d148-742b-4cd6-b56c-277d9694e5be",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "715d5c66-5f76-4f1d-802a-3e30e9773b5b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "663d2157-9d6a-4940-8ba3-d75550f7b9e5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "31e7acba-c026-4d43-a7b4-269ae62de0fa",
"db_currency_id": "5384396d-75e7-4b0b-846d-35cd160a920b",
"db_language_id": "79e6d1f3-1b42-4568-a5c2-01a52f216fbf",
"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-09-23T03:52:25.5542022+00:00"
},
"modified_dateutc": "2026-09-23T03:52:25.5542022+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "963ccee5-5e62-4561-a354-d3161feb2f1f",
"date_reported_by_company": "2026-09-23T03:52:25.5542022+00:00",
"id2": 36,
"company_id": "0a86dcd3-7ab6-44c4-9e11-456cdda3f448",
"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": "96319ce2-e925-4038-a25d-22b70c53a5a2",
"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-09-23T03:52:25.5542022+00:00"
},
"work_instruction_details_id": "8f58ccc3-5461-4a5f-a0c7-29fdd17497fa",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "2c439498-0399-4570-a7ec-fa498fdf12ac",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "ced27319-b824-4ddf-8713-740717c285e0",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-23T03:52:25.5698315+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": "dbd250cb-5695-468d-8821-0c024d59433b",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-23T03:52:25.5698315+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.