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": "de3b70cf-f7e6-4d81-9ab9-4f916d9ec2b7",
"jobs_id": "dc538040-9546-4872-9709-1ba0bf18364e",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "f8ef7453-ff4d-490b-a630-d1b47292dfa0",
"_parent_id": "7199268f-c98f-4758-8180-b4cb2d7cd128",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "afdf234b-a844-4ee7-a411-6122d3ef924f",
"project_reference_back_office": "sample string 5",
"project": {
"id": "dd9c1eb8-fe86-4150-b46e-4aab0b4f45e0",
"_parent_id": "13fff766-7309-4f58-be72-0e89d8163836",
"root_parent_id": "49619f9c-2207-4c9c-aa7a-81ac715c3533",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "44c6eedf-cb26-45a6-aabb-00aa88bd2704",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "8aa0405e-84ba-45fa-8928-c079bc830f44",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "79de21ce-d835-4a92-94dc-ed9e90e65256",
"_parent_code": "sample string 6",
"sales_organization_id": "6b5283f3-9614-4d13-89ea-e97a0164dd2e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "01606b44-af71-47f2-ad05-980c6b126166",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "99143b2c-143b-42ad-9787-d0aad092480f",
"db_currency_id": "e97956a9-75ce-47c1-97ed-165ea5d324ee",
"db_language_id": "61c08312-b7d5-41a7-a86e-a20d72c67b9b",
"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-06-09T04:45:20.0989059+00:00"
},
"modified_dateutc": "2026-06-09T04:45:20.0989059+00:00"
},
"equipment_model_id": "74769d5f-52db-4ffb-8d6f-621450452d47",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "fd642269-efb8-40ab-83b9-76c637fc29e4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "089842cd-cd77-4b0d-8aaa-afdba26f08b9",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "4499bf6a-dc13-4be6-9f20-3a8005c29ac5",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "22cd77da-df40-41f5-96de-224f88b02cb0",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "01606b44-af71-47f2-ad05-980c6b126166",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "99143b2c-143b-42ad-9787-d0aad092480f",
"db_currency_id": "e97956a9-75ce-47c1-97ed-165ea5d324ee",
"db_language_id": "61c08312-b7d5-41a7-a86e-a20d72c67b9b",
"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-06-09T04:45:20.0989059+00:00"
},
"modified_dateutc": "2026-06-09T04:45:20.0989059+00:00"
},
"equipment_family_id": "e66cfbb2-b467-467a-916e-528de133a7b8",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "8aa0405e-84ba-45fa-8928-c079bc830f44",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "79de21ce-d835-4a92-94dc-ed9e90e65256",
"_parent_code": "sample string 6",
"sales_organization_id": "6b5283f3-9614-4d13-89ea-e97a0164dd2e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "01606b44-af71-47f2-ad05-980c6b126166",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "99143b2c-143b-42ad-9787-d0aad092480f",
"db_currency_id": "e97956a9-75ce-47c1-97ed-165ea5d324ee",
"db_language_id": "61c08312-b7d5-41a7-a86e-a20d72c67b9b",
"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-06-09T04:45:20.0989059+00:00"
},
"modified_dateutc": "2026-06-09T04:45:20.0989059+00:00"
},
"date_in_production_since": "2026-06-09T04:45:20.0989059+00:00",
"date_out_of_production_since": "2026-06-09T04:45:20.0989059+00:00",
"date_end_support": "2026-06-09T04:45:20.0989059+00:00",
"sales_organization_id": "c5cdb154-c059-43eb-b5c2-961b04b57894",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "01606b44-af71-47f2-ad05-980c6b126166",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "99143b2c-143b-42ad-9787-d0aad092480f",
"db_currency_id": "e97956a9-75ce-47c1-97ed-165ea5d324ee",
"db_language_id": "61c08312-b7d5-41a7-a86e-a20d72c67b9b",
"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-06-09T04:45:20.0989059+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-06-09T04:45:20.0989059+00:00"
},
"project_status_id": "b408a266-a8f7-4d28-bb25-f8a0d585c2ff",
"project_status_code": "sample string 10",
"project_status": {
"id": "a51355e0-05eb-42f0-b5dd-aae52ce1178d",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "238589b7-be35-494d-9c44-272b5622b8f0",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "01606b44-af71-47f2-ad05-980c6b126166",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "99143b2c-143b-42ad-9787-d0aad092480f",
"db_currency_id": "e97956a9-75ce-47c1-97ed-165ea5d324ee",
"db_language_id": "61c08312-b7d5-41a7-a86e-a20d72c67b9b",
"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-06-09T04:45:20.0989059+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-09T04:45:20.0989059+00:00"
},
"company_id": "995d6676-9aa1-4863-8d3d-526023e64457",
"company_code": "sample string 12",
"db_address_id": "7fc67868-55fb-4917-bff4-0aa82ec296dd",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "dc3bc753-45f8-45c1-a1af-9cabe6912ece",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "dbda2a16-8015-441a-bc1e-144f458ba275",
"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-06-09T04:45:20.0989059+00:00",
"date_create": "2026-06-09T04:45:20.0989059+00:00",
"date_update": "2026-06-09T04:45:20.0989059+00:00",
"updated_by_user_id": "51365026-f8ac-49e1-bdb3-446020c1f523",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-09T04:45:20.0989059+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-06-09T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-09T04:45:20.0989059+00:00",
"date_last_job": "2026-06-09T04:45:20.0989059+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-09T04:45:20.0989059+00:00",
"modified_dateutc": "2026-06-09T04:45:20.0989059+00:00",
"is_mobile_installation": true
},
"job_type_id": "bbbf31c8-92fb-4cb6-a78f-8fb8f22c392e",
"job_type_code": "sample string 7",
"job_type": {
"id": "f17aba79-5910-4a08-bef0-6780360bbf9c",
"name": "sample string 2",
"sales_organization_id": "25ea3620-5695-4cc0-8ec0-b3528612a833",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-06-09T04:45:20.0989059+00:00",
"code": "sample string 7"
},
"job_priority_id": "d95d6909-0854-4d9f-8e0d-1286d7e76168",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "de784dd9-8d64-44f4-b468-0c22bf98b8cf",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "72c90c00-a4cc-416d-8a33-1251c37cbaed",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "01606b44-af71-47f2-ad05-980c6b126166",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "99143b2c-143b-42ad-9787-d0aad092480f",
"db_currency_id": "e97956a9-75ce-47c1-97ed-165ea5d324ee",
"db_language_id": "61c08312-b7d5-41a7-a86e-a20d72c67b9b",
"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-06-09T04:45:20.0989059+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-09T04:45:20.0989059+00:00"
},
"job_status_id": "196a4d19-079b-4fa2-a815-8c59656ac473",
"job_status_code": "sample string 11",
"db_address_id": "6ea305ea-76fc-4607-b887-e8a97c5b0d3b",
"contact_id": "6eae7a29-47a8-4ae7-9ffb-1514fc468a4c",
"requested_by_company_id": "94c8d3fd-6b23-456b-befb-02f1c87c0567",
"requested_by_contact_id": "0ea6915b-bd55-4b4c-96e5-4980381dec86",
"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-06-09T04:45:20.0989059+00:00",
"due_date": "2026-06-09T04:45:20.0989059+00:00",
"date_create": "2026-06-09T04:45:20.0989059+00:00",
"date_update": "2026-06-09T04:45:20.0989059+00:00",
"date_closed": "2026-06-09T04:45:20.0989059+00:00",
"suggested_user_id": "fa1518ae-c707-433b-9160-f4d4b11713ac",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "b795f1d9-e33b-41eb-93b2-619052074c89",
"db_language_id": "9fba9a04-20f2-4bab-996f-1e83e9af9cbc",
"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-06-09T04:45:20.0989059+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "e065fd4a-29c7-42f7-8d1f-9458d684d309",
"sales_organization": {
"id": "01606b44-af71-47f2-ad05-980c6b126166",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "99143b2c-143b-42ad-9787-d0aad092480f",
"db_currency_id": "e97956a9-75ce-47c1-97ed-165ea5d324ee",
"db_language_id": "61c08312-b7d5-41a7-a86e-a20d72c67b9b",
"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-06-09T04:45:20.0989059+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "90c9432c-0e27-4c4d-a6fd-a81fabf5b60b",
"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": "a4f3c0f9-388f-4df5-87b2-ab291bc8d127",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-06-09T04:45:20.0989059+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "052c2d14-3e09-49cd-a904-06569cfce265"
},
"suggested_date_start": "2026-06-09T04:45:20.0989059+00:00",
"skill_id": "54aef1c2-aea9-468c-978b-fae443e10096",
"skill_code": "sample string 32",
"skill": {
"id": "569ff02c-2122-4e1d-a6b9-3bc816f787e5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "78acedec-4d16-4d34-a013-59f8d13bb3e5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "01606b44-af71-47f2-ad05-980c6b126166",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "99143b2c-143b-42ad-9787-d0aad092480f",
"db_currency_id": "e97956a9-75ce-47c1-97ed-165ea5d324ee",
"db_language_id": "61c08312-b7d5-41a7-a86e-a20d72c67b9b",
"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-06-09T04:45:20.0989059+00:00"
},
"modified_dateutc": "2026-06-09T04:45:20.0989059+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "569f5687-a2e3-46df-a059-d702d5bb8346",
"date_reported_by_company": "2026-06-09T04:45:20.0989059+00:00",
"id2": 36,
"company_id": "3660c282-5a4c-4a46-8f78-fc9e31d3b978",
"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": "d1f000f8-5f19-4d8e-90dc-2548146981d7",
"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-06-09T04:45:20.0989059+00:00"
},
"work_instruction_details_id": "7593658b-c0b1-4ade-af8c-135574b0cf17",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "de0b074f-d346-4bfd-95bd-625c04dc38fa",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "45ff24a6-8c03-445d-8542-c8a45743162f",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-06-09T04:45:20.0989059+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": "f05646f4-3a46-4239-b70c-a32250b11953",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-06-09T04:45:20.0989059+00:00"
}