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": "ba0cb1a2-3acf-4e45-a91e-8e5ba6230b14",
"jobs_id": "079737eb-167b-4e74-9175-1a4f47098ca5",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "544fd0d4-8458-4918-b61f-a1fd166cb15c",
"_parent_id": "2e2bc6b8-7d6e-434c-8a4c-a607c0f26a6b",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "2dcc6efd-b3b5-419c-a7f1-379e4cca32ec",
"project_reference_back_office": "sample string 5",
"project": {
"id": "bd16cdd7-64f0-4932-ab2e-8965078cd2f5",
"_parent_id": "32175dc1-7cc3-4a99-b40c-95fad4fcbb1c",
"root_parent_id": "f1070af2-bf93-4f55-8978-fc6d94718f0b",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "dab8ddac-dbc8-42df-9c9d-87de660b61be",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "f3682946-8338-4304-99dc-fd838bfd90b0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "27dbac48-c7a7-4a6f-a599-3c609f7008e9",
"_parent_code": "sample string 6",
"sales_organization_id": "77d0554a-b52d-4b4a-b1d4-e4095528efca",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "475fc6f4-155d-4d12-a934-0a77ddffdcd2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "714efbf5-3a77-4540-9447-135e42c56e4b",
"db_currency_id": "6b7931f0-d846-4312-ad95-78278d53f4e5",
"db_language_id": "5defdcc9-097d-44de-9162-25389862cd88",
"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-15T07:02:11.4631504+00:00"
},
"modified_dateutc": "2026-02-15T07:02:11.4631504+00:00"
},
"equipment_model_id": "b7080906-ca1b-45e8-9097-4624e808bb8c",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "04bcc5e1-1820-492b-b393-c1051392a931",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "616756f3-7667-4550-95f0-dd4e8c42e799",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "154fb339-af57-4b59-bedf-f7a675a5c92b",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "55fee72c-ed12-4148-a3e9-1263ace5b5ad",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "475fc6f4-155d-4d12-a934-0a77ddffdcd2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "714efbf5-3a77-4540-9447-135e42c56e4b",
"db_currency_id": "6b7931f0-d846-4312-ad95-78278d53f4e5",
"db_language_id": "5defdcc9-097d-44de-9162-25389862cd88",
"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-15T07:02:11.4631504+00:00"
},
"modified_dateutc": "2026-02-15T07:02:11.4631504+00:00"
},
"equipment_family_id": "ea6fdffd-e12d-434a-b280-ea83919a7cd7",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "f3682946-8338-4304-99dc-fd838bfd90b0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "27dbac48-c7a7-4a6f-a599-3c609f7008e9",
"_parent_code": "sample string 6",
"sales_organization_id": "77d0554a-b52d-4b4a-b1d4-e4095528efca",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "475fc6f4-155d-4d12-a934-0a77ddffdcd2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "714efbf5-3a77-4540-9447-135e42c56e4b",
"db_currency_id": "6b7931f0-d846-4312-ad95-78278d53f4e5",
"db_language_id": "5defdcc9-097d-44de-9162-25389862cd88",
"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-15T07:02:11.4631504+00:00"
},
"modified_dateutc": "2026-02-15T07:02:11.4631504+00:00"
},
"date_in_production_since": "2026-02-15T07:02:11.4631504+00:00",
"date_out_of_production_since": "2026-02-15T07:02:11.4631504+00:00",
"date_end_support": "2026-02-15T07:02:11.4631504+00:00",
"sales_organization_id": "f3ae9478-6aef-4153-a06a-f92882604e36",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "475fc6f4-155d-4d12-a934-0a77ddffdcd2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "714efbf5-3a77-4540-9447-135e42c56e4b",
"db_currency_id": "6b7931f0-d846-4312-ad95-78278d53f4e5",
"db_language_id": "5defdcc9-097d-44de-9162-25389862cd88",
"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-15T07:02:11.4631504+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-15T07:02:11.4787789+00:00"
},
"project_status_id": "a5b6eb73-0de2-4c2b-8525-d25f8d8f8ef0",
"project_status_code": "sample string 10",
"project_status": {
"id": "cb1ec22e-a87a-4cc4-9a40-1b7c6bef4f27",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "73f012a0-ce3f-4e3f-a53f-6e94c62563c5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "475fc6f4-155d-4d12-a934-0a77ddffdcd2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "714efbf5-3a77-4540-9447-135e42c56e4b",
"db_currency_id": "6b7931f0-d846-4312-ad95-78278d53f4e5",
"db_language_id": "5defdcc9-097d-44de-9162-25389862cd88",
"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-15T07:02:11.4631504+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-15T07:02:11.4787789+00:00"
},
"company_id": "faa97b3e-fa86-41b6-8e1b-e80bce535bc7",
"company_code": "sample string 12",
"db_address_id": "0c2b8cf2-7504-4de1-9776-8117410d6967",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "8f50f8cb-4234-4ffa-be8f-1aad736bbd93",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "b225849c-a9b4-478f-a2fd-5854cd45a1b2",
"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-15T07:02:11.4787789+00:00",
"date_create": "2026-02-15T07:02:11.4787789+00:00",
"date_update": "2026-02-15T07:02:11.4787789+00:00",
"updated_by_user_id": "ad668a67-6f38-46b6-9ed8-1a7c448edd6c",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-02-15T07:02:11.4787789+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-15T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-02-15T07:02:11.4787789+00:00",
"date_last_job": "2026-02-15T07:02:11.4787789+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-02-15T07:02:11.4787789+00:00",
"modified_dateutc": "2026-02-15T07:02:11.4787789+00:00",
"is_mobile_installation": true
},
"job_type_id": "36a42545-80a0-4b51-879a-3c65cc5fa2fd",
"job_type_code": "sample string 7",
"job_type": {
"id": "7f0f55ea-ba79-4882-8342-af533e0d125e",
"name": "sample string 2",
"sales_organization_id": "722b66f9-9f5a-4f8c-85ad-0d958048fe5a",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-02-15T07:02:11.4787789+00:00",
"code": "sample string 7"
},
"job_priority_id": "3851b9f7-0610-4bb0-993f-da06d51e2f8c",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "759de362-27c7-42dc-a91b-6f07376a2608",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "e98c0bce-139f-4b06-abc6-775429c6fa8c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "475fc6f4-155d-4d12-a934-0a77ddffdcd2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "714efbf5-3a77-4540-9447-135e42c56e4b",
"db_currency_id": "6b7931f0-d846-4312-ad95-78278d53f4e5",
"db_language_id": "5defdcc9-097d-44de-9162-25389862cd88",
"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-15T07:02:11.4631504+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-15T07:02:11.4787789+00:00"
},
"job_status_id": "8ea7368f-95e8-4794-b3df-5d6eb38f0cd7",
"job_status_code": "sample string 11",
"db_address_id": "1051e837-4ce3-4bfa-bbe7-cb388ac69629",
"contact_id": "8a32014e-95d7-4c01-8d76-f2e5dbb9d8db",
"requested_by_company_id": "4a7f4e36-9e64-40ce-839b-6966fa66b8a6",
"requested_by_contact_id": "5421be68-5a1b-41bb-be2b-e89e756753b4",
"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-15T07:02:11.4787789+00:00",
"due_date": "2026-02-15T07:02:11.4787789+00:00",
"date_create": "2026-02-15T07:02:11.4787789+00:00",
"date_update": "2026-02-15T07:02:11.4787789+00:00",
"date_closed": "2026-02-15T07:02:11.4787789+00:00",
"suggested_user_id": "8993fe9d-2f06-4e6a-a123-6494882a1878",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "81342def-218c-43b0-8a18-559f451e3a35",
"db_language_id": "7188c49e-eb30-46b0-9a50-4d05341d70f3",
"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-15T07:02:11.4787789+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "12a40de6-3230-4dbf-880d-f06cb717ad02",
"sales_organization": {
"id": "475fc6f4-155d-4d12-a934-0a77ddffdcd2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "714efbf5-3a77-4540-9447-135e42c56e4b",
"db_currency_id": "6b7931f0-d846-4312-ad95-78278d53f4e5",
"db_language_id": "5defdcc9-097d-44de-9162-25389862cd88",
"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-15T07:02:11.4631504+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "fa4544d3-4c55-496b-a584-95eff938e05b",
"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": "f71bc22a-9c38-4714-9d05-428ceae8bdb1",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-02-15T07:02:11.4787789+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "32ea0b45-86b8-40bd-8fc0-631a7b91b38b"
},
"suggested_date_start": "2026-02-15T07:02:11.4787789+00:00",
"skill_id": "66222c4f-8287-467b-9713-11a5aa0bd57a",
"skill_code": "sample string 32",
"skill": {
"id": "984b2681-dae0-435c-80da-f36eee212d93",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "e994b0ad-728f-4a32-974a-73c6497829b1",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "475fc6f4-155d-4d12-a934-0a77ddffdcd2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "714efbf5-3a77-4540-9447-135e42c56e4b",
"db_currency_id": "6b7931f0-d846-4312-ad95-78278d53f4e5",
"db_language_id": "5defdcc9-097d-44de-9162-25389862cd88",
"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-15T07:02:11.4631504+00:00"
},
"modified_dateutc": "2026-02-15T07:02:11.4787789+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "199111b8-d615-45b5-93b5-81a8e2f62af1",
"date_reported_by_company": "2026-02-15T07:02:11.4787789+00:00",
"id2": 36,
"company_id": "2c2b32ac-9065-4f2e-8480-ebf8daa0dbf6",
"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": "5bcc5e88-98a7-4ce1-8f0c-00922df460ae",
"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-15T07:02:11.4787789+00:00"
},
"work_instruction_details_id": "bab5b636-dfb4-4bce-90c1-4243d007a872",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "85c3db1e-9ba3-49e4-8997-ecbae2c98e5c",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "0abb42ee-650e-463c-85da-523e86b2f75a",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-02-15T07:02:11.4787789+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": "9d9f1cba-10da-4a94-bad4-575374f9e4d4",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-02-15T07:02:11.4787789+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.