Retrieves the job work instruction list with the specified key.
Request Information
URI Parameters :
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | globally unique identifier |
Required |
Body Parameters :
None.
Response Information
Resource Description :
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 |
Response Formats
application/json, text/json
Sample:
{
"id": "e6f1ca5d-f093-4b42-bb97-4db3946c09b5",
"jobs_id": "6cb308da-980b-4db6-a20d-c52fd56530b1",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "6f46aafa-49f2-4317-882d-03a285245a27",
"_parent_id": "16365433-417f-4909-a317-a22b8f6d7df4",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "160928a7-267f-461c-9440-449c3d42b9b1",
"project_reference_back_office": "sample string 5",
"project": {
"id": "db60bf4a-311f-4a6b-9120-24f847bcde1b",
"_parent_id": "3b27c400-477a-4ffc-ae53-c9e6c916c3dd",
"root_parent_id": "401d6bc8-a01f-4285-b1e7-d1dacd19f419",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "bef58575-ed74-4a0d-8768-a08ae7bacc8f",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "3b91d318-057d-41ce-8830-d8d24843286d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "98e8e104-bee8-45db-92b4-c3ed36de20c6",
"_parent_code": "sample string 6",
"sales_organization_id": "12e53020-a791-4165-a247-874b57deb3a5",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d7e19b22-02e4-410c-a103-c8c5b2600f35",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1646cb7b-6aaa-425b-a538-41ceda1c40ef",
"db_currency_id": "4e2ad1ba-31bf-495d-85cb-8e85a65b25a7",
"db_language_id": "69504478-3570-47c0-9ac4-4e74303e78da",
"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-05-20T01:49:14.1761295+00:00"
},
"modified_dateutc": "2026-05-20T01:49:14.1761295+00:00"
},
"equipment_model_id": "af1a34d7-cf70-40d4-ae99-8dcf1ad6afc5",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "eff5b0ab-db51-4dab-b0bd-fc33709f7907",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "dd127a78-e0dd-4c8a-ad88-5119aac5e409",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "090b90f1-dcf4-4f01-bf66-8afeb40e7654",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "af23e2db-e8a5-43f5-9957-53636ddbb699",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d7e19b22-02e4-410c-a103-c8c5b2600f35",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1646cb7b-6aaa-425b-a538-41ceda1c40ef",
"db_currency_id": "4e2ad1ba-31bf-495d-85cb-8e85a65b25a7",
"db_language_id": "69504478-3570-47c0-9ac4-4e74303e78da",
"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-05-20T01:49:14.1761295+00:00"
},
"modified_dateutc": "2026-05-20T01:49:14.1761295+00:00"
},
"equipment_family_id": "5bfed9ac-627a-481f-8ea2-75cb7995d965",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "3b91d318-057d-41ce-8830-d8d24843286d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "98e8e104-bee8-45db-92b4-c3ed36de20c6",
"_parent_code": "sample string 6",
"sales_organization_id": "12e53020-a791-4165-a247-874b57deb3a5",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d7e19b22-02e4-410c-a103-c8c5b2600f35",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1646cb7b-6aaa-425b-a538-41ceda1c40ef",
"db_currency_id": "4e2ad1ba-31bf-495d-85cb-8e85a65b25a7",
"db_language_id": "69504478-3570-47c0-9ac4-4e74303e78da",
"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-05-20T01:49:14.1761295+00:00"
},
"modified_dateutc": "2026-05-20T01:49:14.1761295+00:00"
},
"date_in_production_since": "2026-05-20T01:49:14.1761295+00:00",
"date_out_of_production_since": "2026-05-20T01:49:14.1761295+00:00",
"date_end_support": "2026-05-20T01:49:14.1761295+00:00",
"sales_organization_id": "63afc722-5309-44b7-8bda-b11832c9a4b4",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "d7e19b22-02e4-410c-a103-c8c5b2600f35",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1646cb7b-6aaa-425b-a538-41ceda1c40ef",
"db_currency_id": "4e2ad1ba-31bf-495d-85cb-8e85a65b25a7",
"db_language_id": "69504478-3570-47c0-9ac4-4e74303e78da",
"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-05-20T01:49:14.1761295+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-05-20T01:49:14.1761295+00:00"
},
"project_status_id": "e8d6e7b6-e2c5-4ea6-8815-088d56ec7e37",
"project_status_code": "sample string 10",
"project_status": {
"id": "807a83a2-75ef-455e-a7ce-b920b1d1d343",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "fb85f0d1-e891-48a7-9c62-29bf6171c936",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d7e19b22-02e4-410c-a103-c8c5b2600f35",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1646cb7b-6aaa-425b-a538-41ceda1c40ef",
"db_currency_id": "4e2ad1ba-31bf-495d-85cb-8e85a65b25a7",
"db_language_id": "69504478-3570-47c0-9ac4-4e74303e78da",
"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-05-20T01:49:14.1761295+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-20T01:49:14.1761295+00:00"
},
"company_id": "87fd16ea-8ae8-4ddb-9c34-7c9eaea3faba",
"company_code": "sample string 12",
"db_address_id": "27a6bdf0-0df4-4b1c-86b1-0f57414fd31c",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "888850ab-36c7-4325-af2f-0eb3e125f7e3",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "92db0046-6608-4933-9a41-41ee046f1bad",
"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-05-20T01:49:14.1761295+00:00",
"date_create": "2026-05-20T01:49:14.1761295+00:00",
"date_update": "2026-05-20T01:49:14.1761295+00:00",
"updated_by_user_id": "c8027fe8-afe9-4069-b68e-6cbb211f7fe3",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-20T01:49:14.1761295+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-05-20T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-20T01:49:14.1761295+00:00",
"date_last_job": "2026-05-20T01:49:14.1761295+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-20T01:49:14.1761295+00:00",
"modified_dateutc": "2026-05-20T01:49:14.1761295+00:00",
"is_mobile_installation": true
},
"job_type_id": "ce3aa0dc-c256-44b1-9185-d2e90dd9e9d2",
"job_type_code": "sample string 7",
"job_type": {
"id": "68ca1658-1e1c-4c57-af78-9d9201bffea3",
"name": "sample string 2",
"sales_organization_id": "1a4306bd-00a8-4f49-90ad-fe7aba7ca39e",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-20T01:49:14.1761295+00:00",
"code": "sample string 7"
},
"job_priority_id": "f84f5afd-7ff2-4dc6-a029-bfbaee695f3a",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "1e2ef862-b2ca-4426-81d8-68a4f8cf9feb",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "cb5075b1-8ac2-4fe4-a5fb-a551c20eca46",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d7e19b22-02e4-410c-a103-c8c5b2600f35",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1646cb7b-6aaa-425b-a538-41ceda1c40ef",
"db_currency_id": "4e2ad1ba-31bf-495d-85cb-8e85a65b25a7",
"db_language_id": "69504478-3570-47c0-9ac4-4e74303e78da",
"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-05-20T01:49:14.1761295+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-20T01:49:14.1761295+00:00"
},
"job_status_id": "ad160879-185c-468c-a386-42e1f4bcee80",
"job_status_code": "sample string 11",
"db_address_id": "00f05c28-9904-4343-9989-cd33815ba84a",
"contact_id": "3ac4cdb1-9caf-465a-9c65-bec7d321da9d",
"requested_by_company_id": "4c46d074-e864-47dc-8d08-9ed83bd1fdb7",
"requested_by_contact_id": "89f72a91-ef27-415b-9db2-0f5446a58fda",
"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-05-20T01:49:14.1761295+00:00",
"due_date": "2026-05-20T01:49:14.1761295+00:00",
"date_create": "2026-05-20T01:49:14.1761295+00:00",
"date_update": "2026-05-20T01:49:14.1761295+00:00",
"date_closed": "2026-05-20T01:49:14.1761295+00:00",
"suggested_user_id": "0f42a8a3-a7e3-4ad1-8920-a2796cddae39",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "33070a8e-d7ce-404a-b27c-182f89a6db51",
"db_language_id": "260a52b1-6560-47ad-9c58-71784c55ec22",
"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-05-20T01:49:14.1761295+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "1c0292de-0e66-4b54-a363-2cbd9c074a7f",
"sales_organization": {
"id": "d7e19b22-02e4-410c-a103-c8c5b2600f35",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1646cb7b-6aaa-425b-a538-41ceda1c40ef",
"db_currency_id": "4e2ad1ba-31bf-495d-85cb-8e85a65b25a7",
"db_language_id": "69504478-3570-47c0-9ac4-4e74303e78da",
"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-05-20T01:49:14.1761295+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "9147d7c7-104b-4316-b2f9-a5433380e5f9",
"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": "87f44045-460a-4556-8131-ecab4961ce5d",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-20T01:49:14.1761295+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "ee3ddc9c-8318-4c19-ab10-e573063175c2"
},
"suggested_date_start": "2026-05-20T01:49:14.1761295+00:00",
"skill_id": "7e3ec931-7d7a-44cd-ad40-bfedf90d73cd",
"skill_code": "sample string 32",
"skill": {
"id": "af8721d2-ff8c-4f89-9052-1cc7d620ac8e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "3fcd9932-3157-4eff-aa76-c216c0e61f26",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d7e19b22-02e4-410c-a103-c8c5b2600f35",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1646cb7b-6aaa-425b-a538-41ceda1c40ef",
"db_currency_id": "4e2ad1ba-31bf-495d-85cb-8e85a65b25a7",
"db_language_id": "69504478-3570-47c0-9ac4-4e74303e78da",
"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-05-20T01:49:14.1761295+00:00"
},
"modified_dateutc": "2026-05-20T01:49:14.1761295+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "f851f3a8-da2b-4c14-95e5-0e0d96d8c75d",
"date_reported_by_company": "2026-05-20T01:49:14.1761295+00:00",
"id2": 36,
"company_id": "f972dab9-10a7-4df8-8df2-af8ede7d9336",
"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": "8b79f574-21ee-42bc-b08f-555fb6fde752",
"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-05-20T01:49:14.1761295+00:00"
},
"work_instruction_details_id": "06163bca-6776-4ca0-ab86-ad4932355d24",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "0cefdfa6-c413-4911-aa02-16d1fe718ce2",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "08856a0e-448c-4916-ac81-3c6aea1fb35b",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-20T01:49:14.1761295+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": "d5607977-bd75-4a23-b8cb-b377ecf06471",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-20T01:49:14.1761295+00:00"
}