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": "29b326a8-fcfd-4583-baab-a779dcf78d62",
"jobs_id": "3c25e1fd-7a4d-4cad-9edd-96a55276851c",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "4d4996ce-3094-4726-b625-46e5b7aa2e54",
"_parent_id": "b419ff90-bc0c-4355-9378-6a016955aca7",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "bd8b61fd-5693-4d7a-8f69-c12fb0d4c290",
"project_reference_back_office": "sample string 5",
"project": {
"id": "ac351d15-b781-4547-b129-cf17558a6484",
"_parent_id": "e8a6764a-3a59-4396-9312-f456764a034f",
"root_parent_id": "325ebf67-d5ba-49a4-b6f4-867121b86600",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "de803359-d23e-4173-9c21-5536f886cc07",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "ec382283-761e-41d6-992e-3b12b0c1b1a9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2972dad5-85f6-4a22-8488-d336a942a9f8",
"_parent_code": "sample string 6",
"sales_organization_id": "9303adf7-bd2a-4698-ac6c-70c93aa52d40",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ac4a6cf7-25c3-474e-a171-58da8abcb5f9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0a303c56-7c6f-4932-ac78-288864bd8506",
"db_currency_id": "feaad1b4-98e8-4822-90bb-e8cd8868b004",
"db_language_id": "b0d43b0e-b7cb-487e-8154-5219ac5e10e7",
"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-07-28T06:55:15.7571546+00:00"
},
"modified_dateutc": "2026-07-28T06:55:15.7571546+00:00"
},
"equipment_model_id": "59748f43-56b0-4bde-8a33-808b864d1586",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "58cebec2-ad2a-4dc4-bf65-b3b5c6cb21dd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "2563db0d-01fe-4d5f-9ee9-2e3335e7e4d8",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "6ab6fddd-dcbd-47bc-897a-78a9864f2e57",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "acc14137-941f-4409-9b3d-e323efac18c7",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ac4a6cf7-25c3-474e-a171-58da8abcb5f9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0a303c56-7c6f-4932-ac78-288864bd8506",
"db_currency_id": "feaad1b4-98e8-4822-90bb-e8cd8868b004",
"db_language_id": "b0d43b0e-b7cb-487e-8154-5219ac5e10e7",
"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-07-28T06:55:15.7571546+00:00"
},
"modified_dateutc": "2026-07-28T06:55:15.7571546+00:00"
},
"equipment_family_id": "d3d973f0-44b3-436c-8c67-a58ee7449410",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "ec382283-761e-41d6-992e-3b12b0c1b1a9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2972dad5-85f6-4a22-8488-d336a942a9f8",
"_parent_code": "sample string 6",
"sales_organization_id": "9303adf7-bd2a-4698-ac6c-70c93aa52d40",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ac4a6cf7-25c3-474e-a171-58da8abcb5f9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0a303c56-7c6f-4932-ac78-288864bd8506",
"db_currency_id": "feaad1b4-98e8-4822-90bb-e8cd8868b004",
"db_language_id": "b0d43b0e-b7cb-487e-8154-5219ac5e10e7",
"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-07-28T06:55:15.7571546+00:00"
},
"modified_dateutc": "2026-07-28T06:55:15.7571546+00:00"
},
"date_in_production_since": "2026-07-28T06:55:15.7571546+00:00",
"date_out_of_production_since": "2026-07-28T06:55:15.7571546+00:00",
"date_end_support": "2026-07-28T06:55:15.7571546+00:00",
"sales_organization_id": "9fd1e58f-d298-40f3-9651-2b06cd1f064e",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "ac4a6cf7-25c3-474e-a171-58da8abcb5f9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0a303c56-7c6f-4932-ac78-288864bd8506",
"db_currency_id": "feaad1b4-98e8-4822-90bb-e8cd8868b004",
"db_language_id": "b0d43b0e-b7cb-487e-8154-5219ac5e10e7",
"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-07-28T06:55:15.7571546+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-07-28T06:55:15.7571546+00:00"
},
"project_status_id": "d047f3d3-3045-4876-ae1d-864ff592a4e9",
"project_status_code": "sample string 10",
"project_status": {
"id": "f878a7ae-8755-4872-9571-8260b2005384",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "74a25504-85af-404d-98de-7f46338e3a1b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ac4a6cf7-25c3-474e-a171-58da8abcb5f9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0a303c56-7c6f-4932-ac78-288864bd8506",
"db_currency_id": "feaad1b4-98e8-4822-90bb-e8cd8868b004",
"db_language_id": "b0d43b0e-b7cb-487e-8154-5219ac5e10e7",
"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-07-28T06:55:15.7571546+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-28T06:55:15.7571546+00:00"
},
"company_id": "569d6777-0101-4385-bc0c-c354d072ff14",
"company_code": "sample string 12",
"db_address_id": "beb3c686-149d-420b-9abd-ff361076087c",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "1f74d89d-7cfc-4f76-8803-28d59ebde17a",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "c6a1814a-69ec-4a58-89ce-5c92e122f7c7",
"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-07-28T06:55:15.7571546+00:00",
"date_create": "2026-07-28T06:55:15.7571546+00:00",
"date_update": "2026-07-28T06:55:15.7571546+00:00",
"updated_by_user_id": "d7279743-05a8-43da-8bbe-5b91355bd6d5",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-28T06:55:15.7571546+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-07-28T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-28T06:55:15.7571546+00:00",
"date_last_job": "2026-07-28T06:55:15.7571546+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-28T06:55:15.7571546+00:00",
"modified_dateutc": "2026-07-28T06:55:15.7571546+00:00",
"is_mobile_installation": true
},
"job_type_id": "9591fbdd-122d-422c-9e49-a64dd6ba3d34",
"job_type_code": "sample string 7",
"job_type": {
"id": "c317c273-b340-4533-a25e-e2e9aaf610b8",
"name": "sample string 2",
"sales_organization_id": "8af8f2d2-78da-4722-8bb0-89a14551ace0",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-28T06:55:15.7571546+00:00",
"code": "sample string 7"
},
"job_priority_id": "5b989435-a3ef-44f1-bc16-6d7b6989fe24",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "cca32de2-8b43-4024-bdf2-c524ef36227f",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "fff625c4-6c79-41bb-bff7-5267e17622d3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ac4a6cf7-25c3-474e-a171-58da8abcb5f9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0a303c56-7c6f-4932-ac78-288864bd8506",
"db_currency_id": "feaad1b4-98e8-4822-90bb-e8cd8868b004",
"db_language_id": "b0d43b0e-b7cb-487e-8154-5219ac5e10e7",
"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-07-28T06:55:15.7571546+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-28T06:55:15.7571546+00:00"
},
"job_status_id": "8ebf36f1-3d24-4fca-9246-2f52e5b89a68",
"job_status_code": "sample string 11",
"db_address_id": "4499c1e5-45dc-4a89-a13a-b3770cce8401",
"contact_id": "9a11f6e3-872f-489c-83b2-d02af93af06b",
"requested_by_company_id": "ce6a89e0-077b-4749-b57f-6cad9c15e4ec",
"requested_by_contact_id": "e5354aa9-5cd4-4ee6-9e82-71fece1881a8",
"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-07-28T06:55:15.7571546+00:00",
"due_date": "2026-07-28T06:55:15.7571546+00:00",
"date_create": "2026-07-28T06:55:15.7571546+00:00",
"date_update": "2026-07-28T06:55:15.7571546+00:00",
"date_closed": "2026-07-28T06:55:15.7571546+00:00",
"suggested_user_id": "23f5c53c-458f-4b0e-992a-923262f7f854",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "5e5e67a7-c4b8-4bf2-a464-8b4a2f1d8b3f",
"db_language_id": "252fcefb-a734-42f5-bd5b-356856419426",
"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-07-28T06:55:15.7571546+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "baca82fb-8a6a-4b38-b4b4-5633abfb49cd",
"sales_organization": {
"id": "ac4a6cf7-25c3-474e-a171-58da8abcb5f9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0a303c56-7c6f-4932-ac78-288864bd8506",
"db_currency_id": "feaad1b4-98e8-4822-90bb-e8cd8868b004",
"db_language_id": "b0d43b0e-b7cb-487e-8154-5219ac5e10e7",
"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-07-28T06:55:15.7571546+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "77ff6443-46c4-40c9-868f-b34d99b1ff1a",
"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": "4f6aab71-be21-4a2a-ae90-594978f49810",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-28T06:55:15.7571546+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "3b28fd36-f356-4210-aa1c-50c3ac00ddcb"
},
"suggested_date_start": "2026-07-28T06:55:15.7571546+00:00",
"skill_id": "cbdefbc5-a2ec-44d3-8429-3335ffd01f6a",
"skill_code": "sample string 32",
"skill": {
"id": "16786e30-612f-4762-82cd-0f282e23a71b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "6f604030-0c79-43d3-85db-c47ac52538d4",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ac4a6cf7-25c3-474e-a171-58da8abcb5f9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0a303c56-7c6f-4932-ac78-288864bd8506",
"db_currency_id": "feaad1b4-98e8-4822-90bb-e8cd8868b004",
"db_language_id": "b0d43b0e-b7cb-487e-8154-5219ac5e10e7",
"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-07-28T06:55:15.7571546+00:00"
},
"modified_dateutc": "2026-07-28T06:55:15.7571546+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "57205961-2dca-4296-b377-8e2f6a22b7c2",
"date_reported_by_company": "2026-07-28T06:55:15.7571546+00:00",
"id2": 36,
"company_id": "8679bfd8-b9fb-474e-9b5a-5464d5d151d2",
"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": "ef2096bb-f8e4-44e4-87c7-df7d0177f0c6",
"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-07-28T06:55:15.7571546+00:00"
},
"work_instruction_details_id": "0cc21d5b-03b1-4526-afaf-d0b551785222",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "f789cf9d-ef7c-446e-9e07-cabaa3eb704e",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "72032af2-c35b-4f6d-b356-1c47a7407578",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-28T06:55:15.7571546+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": "36816704-afa4-476d-a324-88cae29f8b12",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-28T06:55:15.7571546+00:00"
}