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": "b862bf4f-8346-4919-9892-e46dde0bd50e",
"jobs_id": "c3080f6d-b10c-4177-ac53-8437daeb7a7e",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "ee09f438-55f0-4923-8253-7d27e2faa443",
"_parent_id": "51b0d82b-f5d7-4473-9ab5-5ba6a73aefb3",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "a896312d-a867-4872-b98b-b37ffe252e93",
"project_reference_back_office": "sample string 5",
"project": {
"id": "fa0d6ac5-c2e1-41b0-964d-dca50de27cd7",
"_parent_id": "6267bdc6-1ebe-4592-bb7d-ad203b6c7c92",
"root_parent_id": "b4f33e6f-908f-4386-89bb-42f92a9b2d99",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "5b0778db-4b2c-4c71-ab1f-1f0ea1d1a3bd",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "a9a186d9-2211-4448-b7e2-f73a8697c8b8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "6cf3e219-c83f-400e-b29f-3d91c882e6ac",
"_parent_code": "sample string 6",
"sales_organization_id": "e548e7f3-86bb-4257-906a-92a3ce239c1b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "7b908485-0a17-4db4-97af-eced532de439",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "76faab38-a568-42a5-a6da-f95965fe83cf",
"db_currency_id": "1da32028-fceb-477c-b0a3-b96dd64601af",
"db_language_id": "7c910978-a28d-4343-aba7-6f142817191b",
"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-11T12:57:17.8225416+00:00"
},
"modified_dateutc": "2025-12-11T12:57:17.8225416+00:00"
},
"equipment_model_id": "f3b9164c-e839-49a6-bb21-8de6c7b89650",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "4167ab62-0c7f-4719-9361-e25b27ce81ce",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "f42d6430-c193-4fc7-9f09-7bd24a05dd71",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "a5f0d808-7e06-4671-a261-e3663d170ff4",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "9d88f70e-6272-4963-a557-10774547cff4",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "7b908485-0a17-4db4-97af-eced532de439",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "76faab38-a568-42a5-a6da-f95965fe83cf",
"db_currency_id": "1da32028-fceb-477c-b0a3-b96dd64601af",
"db_language_id": "7c910978-a28d-4343-aba7-6f142817191b",
"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-11T12:57:17.8225416+00:00"
},
"modified_dateutc": "2025-12-11T12:57:17.8225416+00:00"
},
"equipment_family_id": "92de0257-4081-4928-91ba-85c5522e225b",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "a9a186d9-2211-4448-b7e2-f73a8697c8b8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "6cf3e219-c83f-400e-b29f-3d91c882e6ac",
"_parent_code": "sample string 6",
"sales_organization_id": "e548e7f3-86bb-4257-906a-92a3ce239c1b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "7b908485-0a17-4db4-97af-eced532de439",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "76faab38-a568-42a5-a6da-f95965fe83cf",
"db_currency_id": "1da32028-fceb-477c-b0a3-b96dd64601af",
"db_language_id": "7c910978-a28d-4343-aba7-6f142817191b",
"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-11T12:57:17.8225416+00:00"
},
"modified_dateutc": "2025-12-11T12:57:17.8225416+00:00"
},
"date_in_production_since": "2025-12-11T12:57:17.8225416+00:00",
"date_out_of_production_since": "2025-12-11T12:57:17.8225416+00:00",
"date_end_support": "2025-12-11T12:57:17.8225416+00:00",
"sales_organization_id": "d61e7026-29ba-4ae0-bc2e-1e03941f7d6f",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "7b908485-0a17-4db4-97af-eced532de439",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "76faab38-a568-42a5-a6da-f95965fe83cf",
"db_currency_id": "1da32028-fceb-477c-b0a3-b96dd64601af",
"db_language_id": "7c910978-a28d-4343-aba7-6f142817191b",
"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-11T12:57:17.8225416+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-11T12:57:17.8225416+00:00"
},
"project_status_id": "226b2a62-c704-40b6-a6f8-88292c16c62b",
"project_status_code": "sample string 10",
"project_status": {
"id": "9a82841c-de0f-46a1-9d24-e23af94e85f7",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "ea339e1d-8f99-407d-bc5c-947126dba283",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7b908485-0a17-4db4-97af-eced532de439",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "76faab38-a568-42a5-a6da-f95965fe83cf",
"db_currency_id": "1da32028-fceb-477c-b0a3-b96dd64601af",
"db_language_id": "7c910978-a28d-4343-aba7-6f142817191b",
"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-11T12:57:17.8225416+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-11T12:57:17.8225416+00:00"
},
"company_id": "a4c8ac6c-f9e0-4b5f-bf45-dd11a829fb00",
"company_code": "sample string 12",
"db_address_id": "8df5ccea-1298-44ec-9ea9-b34037e68f28",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "7d17a346-a02d-4a47-86bd-13cdda7523ef",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "61daa7ab-1797-49f4-a0a0-aec004333076",
"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-11T12:57:17.8225416+00:00",
"date_create": "2025-12-11T12:57:17.8225416+00:00",
"date_update": "2025-12-11T12:57:17.8225416+00:00",
"updated_by_user_id": "c5d0f958-7f87-4225-afa6-60fd3c2ea704",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-11T12:57:17.8225416+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-11T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-11T12:57:17.8225416+00:00",
"date_last_job": "2025-12-11T12:57:17.8225416+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-11T12:57:17.8225416+00:00",
"modified_dateutc": "2025-12-11T12:57:17.8225416+00:00",
"is_mobile_installation": true
},
"job_type_id": "4ca4e402-0a4a-444d-85c1-85dfdd75d0b1",
"job_type_code": "sample string 7",
"job_type": {
"id": "c83dc426-7bfe-477a-8a35-7e39882da202",
"name": "sample string 2",
"sales_organization_id": "6833a0cc-fe2f-4175-a99f-b4f142d25dd6",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-11T12:57:17.8225416+00:00",
"code": "sample string 7"
},
"job_priority_id": "1dd09a83-c8a6-4415-adee-a25f36688532",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "959b5a16-c00a-4ec8-9554-e8453e5f6682",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "6ce27ad5-ebc9-4224-b624-0d8cbbfbe3a2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7b908485-0a17-4db4-97af-eced532de439",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "76faab38-a568-42a5-a6da-f95965fe83cf",
"db_currency_id": "1da32028-fceb-477c-b0a3-b96dd64601af",
"db_language_id": "7c910978-a28d-4343-aba7-6f142817191b",
"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-11T12:57:17.8225416+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-11T12:57:17.8225416+00:00"
},
"job_status_id": "0c75b8f7-d6c1-4415-a385-d8b72bb8e76d",
"job_status_code": "sample string 11",
"db_address_id": "9ae10d05-a122-4ed6-8bc2-7aa5e6d695be",
"contact_id": "b17d1488-d2b4-462c-a441-a982c89cf8d4",
"requested_by_company_id": "09818648-8115-4d7f-8c10-ac5573239510",
"requested_by_contact_id": "b0d620b5-db9f-49bc-9a17-91a6bd71566a",
"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-11T12:57:17.8225416+00:00",
"due_date": "2025-12-11T12:57:17.8225416+00:00",
"date_create": "2025-12-11T12:57:17.8225416+00:00",
"date_update": "2025-12-11T12:57:17.8225416+00:00",
"date_closed": "2025-12-11T12:57:17.8225416+00:00",
"suggested_user_id": "963e957a-442f-4bed-aefb-15c7b5071133",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "572831f3-beae-4536-afa9-7c923e02e849",
"db_language_id": "660ed100-6a1a-4248-b650-71d6afc6a36b",
"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-11T12:57:17.8225416+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "fe4fe8aa-298d-4544-aee0-489f51edafe5",
"sales_organization": {
"id": "7b908485-0a17-4db4-97af-eced532de439",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "76faab38-a568-42a5-a6da-f95965fe83cf",
"db_currency_id": "1da32028-fceb-477c-b0a3-b96dd64601af",
"db_language_id": "7c910978-a28d-4343-aba7-6f142817191b",
"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-11T12:57:17.8225416+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "505744a6-618c-492e-8b55-aa5db808fe19",
"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": "0fd3148d-badf-4ad2-9b31-c53c5cc4afa0",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-11T12:57:17.8225416+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "827e2681-7a77-4be4-9f8d-80ad4e43eae1"
},
"suggested_date_start": "2025-12-11T12:57:17.8225416+00:00",
"skill_id": "20afa448-2c3e-472f-8b4a-d54b0ddaa3dd",
"skill_code": "sample string 32",
"skill": {
"id": "ea2cc6c9-0bd4-493c-a0ff-3087f79b32e1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "cc020825-1a18-4a11-a236-b0ceeacb6069",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7b908485-0a17-4db4-97af-eced532de439",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "76faab38-a568-42a5-a6da-f95965fe83cf",
"db_currency_id": "1da32028-fceb-477c-b0a3-b96dd64601af",
"db_language_id": "7c910978-a28d-4343-aba7-6f142817191b",
"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-11T12:57:17.8225416+00:00"
},
"modified_dateutc": "2025-12-11T12:57:17.8225416+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "8c32209f-4129-4f77-bdde-497091f958de",
"date_reported_by_company": "2025-12-11T12:57:17.8225416+00:00",
"id2": 36,
"company_id": "faa02e10-c0bd-4559-8618-40d9a74dad8e",
"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": "081917a1-00f4-44d8-b973-06cbe8100a8a",
"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-11T12:57:17.8225416+00:00"
},
"work_instruction_details_id": "36004f88-a288-4d1d-b8b7-bb6701907f51",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "1173e3b6-9428-49c5-a845-d4ab0965b39e",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "bba07b66-bce6-48d9-a8ed-7f7b82f23176",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-11T12:57:17.8225416+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": "498a62aa-25fd-4def-91d0-8a42e555dfb0",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-11T12:57:17.8225416+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.