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": "475e74b3-9ac2-41c9-8acc-7cdab446bd84",
"jobs_id": "fc234f81-45cf-48da-a637-ee2478b82bc0",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "6ac89474-cd98-4047-a1f8-7f6dfacc26f5",
"_parent_id": "dd9d0d7e-ec47-4eaf-9981-b36498fb3dec",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "92c4947e-50e4-44fa-8a34-afbffb7aaad7",
"project_reference_back_office": "sample string 5",
"project": {
"id": "e1fc3b43-053b-4193-93f5-efcf13c9c187",
"_parent_id": "7f82090f-747a-470e-b9c0-6215ee706887",
"root_parent_id": "439efda4-a7cd-427f-9302-1d7f431e1f2b",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "c25db5e0-421e-47f5-aaff-478aeeb4d991",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "95283a26-be1d-47fc-8f92-5ce5d92d32e7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b55a6ffb-b590-4927-ad70-02c785ba537c",
"_parent_code": "sample string 6",
"sales_organization_id": "c5e634bb-b6e7-4e15-9d93-ddc54d638984",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d7b18d58-b6e1-4083-b5a5-a705fc333a75",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7a5d27c0-3d2b-4496-9946-acf68c888945",
"db_currency_id": "ab09def1-1cb0-4218-ac7a-61b6db153e5e",
"db_language_id": "bf782914-bb85-42c3-ae51-503ba4addc11",
"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-02T06:21:43.6227964+00:00"
},
"modified_dateutc": "2026-05-02T06:21:43.6227964+00:00"
},
"equipment_model_id": "dc1645ec-2ead-437a-a148-2fe495720933",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "ea93f899-598b-4812-a9d6-79cfebc12cad",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "c93829d6-e15f-45f6-812d-e5a26ee68720",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "72237010-6023-4d9a-933e-aa5fa9881048",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "3c88a218-c7a6-48ba-b791-708b31e201f8",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d7b18d58-b6e1-4083-b5a5-a705fc333a75",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7a5d27c0-3d2b-4496-9946-acf68c888945",
"db_currency_id": "ab09def1-1cb0-4218-ac7a-61b6db153e5e",
"db_language_id": "bf782914-bb85-42c3-ae51-503ba4addc11",
"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-02T06:21:43.6227964+00:00"
},
"modified_dateutc": "2026-05-02T06:21:43.6227964+00:00"
},
"equipment_family_id": "bc8319ca-e4f8-4b26-af32-69f5394cf92f",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "95283a26-be1d-47fc-8f92-5ce5d92d32e7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b55a6ffb-b590-4927-ad70-02c785ba537c",
"_parent_code": "sample string 6",
"sales_organization_id": "c5e634bb-b6e7-4e15-9d93-ddc54d638984",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d7b18d58-b6e1-4083-b5a5-a705fc333a75",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7a5d27c0-3d2b-4496-9946-acf68c888945",
"db_currency_id": "ab09def1-1cb0-4218-ac7a-61b6db153e5e",
"db_language_id": "bf782914-bb85-42c3-ae51-503ba4addc11",
"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-02T06:21:43.6227964+00:00"
},
"modified_dateutc": "2026-05-02T06:21:43.6227964+00:00"
},
"date_in_production_since": "2026-05-02T06:21:43.6227964+00:00",
"date_out_of_production_since": "2026-05-02T06:21:43.6227964+00:00",
"date_end_support": "2026-05-02T06:21:43.6227964+00:00",
"sales_organization_id": "468f9fb6-20de-4315-bc0f-755e4739e331",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "d7b18d58-b6e1-4083-b5a5-a705fc333a75",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7a5d27c0-3d2b-4496-9946-acf68c888945",
"db_currency_id": "ab09def1-1cb0-4218-ac7a-61b6db153e5e",
"db_language_id": "bf782914-bb85-42c3-ae51-503ba4addc11",
"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-02T06:21:43.6227964+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-02T06:21:43.6227964+00:00"
},
"project_status_id": "85f0abc2-25f9-4a0a-be5f-7b2448ca18ed",
"project_status_code": "sample string 10",
"project_status": {
"id": "2d7aab12-9ba8-4249-981b-43d26baf827b",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "fab10bae-afd4-4fdc-83bf-4484a6944491",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d7b18d58-b6e1-4083-b5a5-a705fc333a75",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7a5d27c0-3d2b-4496-9946-acf68c888945",
"db_currency_id": "ab09def1-1cb0-4218-ac7a-61b6db153e5e",
"db_language_id": "bf782914-bb85-42c3-ae51-503ba4addc11",
"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-02T06:21:43.6227964+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-02T06:21:43.6227964+00:00"
},
"company_id": "ddcf4f22-80f8-4a59-b1c0-a7c04de025b6",
"company_code": "sample string 12",
"db_address_id": "8aa9810f-a534-4060-ac46-4afb1994b2e9",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "d5f5ba04-2bb8-4c9d-9dd8-8b723e336b35",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "1cd9cb67-f955-432b-a5ee-08ecbb2cdecc",
"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-02T06:21:43.6227964+00:00",
"date_create": "2026-05-02T06:21:43.6227964+00:00",
"date_update": "2026-05-02T06:21:43.6227964+00:00",
"updated_by_user_id": "81eaed90-3eba-456b-8268-6b3aa8653b70",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-02T06:21:43.6227964+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-02T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-02T06:21:43.6227964+00:00",
"date_last_job": "2026-05-02T06:21:43.6227964+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-02T06:21:43.6227964+00:00",
"modified_dateutc": "2026-05-02T06:21:43.6227964+00:00",
"is_mobile_installation": true
},
"job_type_id": "f20ee505-1846-4c78-aa38-3778f9b4cee5",
"job_type_code": "sample string 7",
"job_type": {
"id": "cf346cb2-7f8d-4e01-be84-8e5cbc0cc8d8",
"name": "sample string 2",
"sales_organization_id": "25670ae9-7839-4c59-88a1-b847c8b65ade",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-02T06:21:43.6227964+00:00",
"code": "sample string 7"
},
"job_priority_id": "49049bd7-75c0-4903-a49f-98030408870c",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "b85030df-5f03-428f-9cad-fda3fa9552c3",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "6cb61f99-1a0d-4f02-96c3-c9650643cfaa",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d7b18d58-b6e1-4083-b5a5-a705fc333a75",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7a5d27c0-3d2b-4496-9946-acf68c888945",
"db_currency_id": "ab09def1-1cb0-4218-ac7a-61b6db153e5e",
"db_language_id": "bf782914-bb85-42c3-ae51-503ba4addc11",
"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-02T06:21:43.6227964+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-02T06:21:43.6227964+00:00"
},
"job_status_id": "02d7c7d1-bd89-4377-a435-f8731aa874ef",
"job_status_code": "sample string 11",
"db_address_id": "ea13ac49-2a2c-4e56-b354-81abf20486e7",
"contact_id": "e79b951d-bb89-4544-b506-bf4ed0a2059c",
"requested_by_company_id": "1e042e90-4dbf-449b-9a6c-6be31aba8971",
"requested_by_contact_id": "4688aa21-514d-4621-bce7-4235c8bec1e4",
"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-02T06:21:43.6227964+00:00",
"due_date": "2026-05-02T06:21:43.6227964+00:00",
"date_create": "2026-05-02T06:21:43.6227964+00:00",
"date_update": "2026-05-02T06:21:43.6227964+00:00",
"date_closed": "2026-05-02T06:21:43.6227964+00:00",
"suggested_user_id": "761f53f1-03aa-47a6-a4bd-bc8c6a24ee80",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "dfcb872a-4e7c-4285-bd8b-129f4704f3f3",
"db_language_id": "73030cfa-3aa6-454e-b04c-bdfc75e23333",
"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-02T06:21:43.6227964+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "b4c22530-a994-464d-86e2-460271d7b7d7",
"sales_organization": {
"id": "d7b18d58-b6e1-4083-b5a5-a705fc333a75",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7a5d27c0-3d2b-4496-9946-acf68c888945",
"db_currency_id": "ab09def1-1cb0-4218-ac7a-61b6db153e5e",
"db_language_id": "bf782914-bb85-42c3-ae51-503ba4addc11",
"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-02T06:21:43.6227964+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "4f45859b-d10d-4c82-b785-a2a4ddc422fd",
"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": "14e60af8-4b8c-402b-9901-09305fd7ff1a",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-02T06:21:43.6227964+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "aa56116f-b3f4-4dd4-8400-05278282cba2"
},
"suggested_date_start": "2026-05-02T06:21:43.6227964+00:00",
"skill_id": "1329dcfc-505d-436d-a06b-dcbd2a452457",
"skill_code": "sample string 32",
"skill": {
"id": "a7fc4ac7-77ee-4676-bdd2-5e2038148361",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "7fe423f6-80e4-4eb5-b554-3924855899d0",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d7b18d58-b6e1-4083-b5a5-a705fc333a75",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7a5d27c0-3d2b-4496-9946-acf68c888945",
"db_currency_id": "ab09def1-1cb0-4218-ac7a-61b6db153e5e",
"db_language_id": "bf782914-bb85-42c3-ae51-503ba4addc11",
"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-02T06:21:43.6227964+00:00"
},
"modified_dateutc": "2026-05-02T06:21:43.6227964+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "6f7945a9-b2d5-46bc-bae4-55c867f27738",
"date_reported_by_company": "2026-05-02T06:21:43.6227964+00:00",
"id2": 36,
"company_id": "95e155e7-e4ed-47ec-8610-09c3b08a3a6e",
"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": "eba0efb3-b4a8-4e81-9846-5a7cb3266a47",
"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-02T06:21:43.6227964+00:00"
},
"work_instruction_details_id": "cb740637-36b6-4ba0-bc1b-ff5362bb23bb",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "01167b85-9695-486f-9182-c1bc25407215",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "6ccab7cd-cb0e-49b8-8801-0c20748a43b8",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-02T06:21:43.6227964+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": "264b0304-0779-46c3-9a56-845b9abdf28d",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-02T06:21:43.6227964+00:00"
}