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": "ddbc4380-b5be-47e6-b25f-f3a7dfb32279",
"jobs_id": "3846b937-6a07-4cc5-b991-cb10ce1a57f8",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "fa1d94c3-e579-4bcf-a521-b5eb35e935b9",
"_parent_id": "505f4d80-19a5-4f9c-a2b3-3c34e57fa63e",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "d7dc5ff1-912e-41de-bcbe-96d63e249f05",
"project_reference_back_office": "sample string 5",
"project": {
"id": "ce31973c-e7ae-4602-a746-7014da46d09f",
"_parent_id": "7bc9ace7-f81b-414c-8c31-219c091b6a21",
"root_parent_id": "f6313cc6-9c79-41c7-82b7-96cf8fdc4e5d",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "f81722b5-f620-46f2-9c6e-b8f10edc0209",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "65e7cd9e-a423-4e92-9a91-31d83f7b226d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9a1b670c-9fdb-4b82-9c1d-6a69fa2651b8",
"_parent_code": "sample string 6",
"sales_organization_id": "9a2f41e2-a211-4f4c-8881-83b6608be7d9",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "92f9ba32-8b9d-4a92-9c88-7274e386b341",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d1c5df9a-6eca-4b82-9ba6-0cf3136e5342",
"db_currency_id": "ca50a60c-1325-4dd4-8bdf-d6a54950a4d4",
"db_language_id": "20f1d822-9cca-49b4-af62-9239f63ea240",
"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-23T23:55:00.3712218+00:00"
},
"modified_dateutc": "2025-12-23T23:55:00.3712218+00:00"
},
"equipment_model_id": "4ad97f4a-54d7-4472-94d3-7c83f7c9277a",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "3bed060b-7c96-421a-9958-5461101c1941",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "0985d873-fc48-412a-b8eb-fc9e81587ae1",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "d6666229-8f64-4ad8-a8de-f309d65256a9",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "8a5c7bb9-0074-4203-8b83-3698b7948f72",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "92f9ba32-8b9d-4a92-9c88-7274e386b341",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d1c5df9a-6eca-4b82-9ba6-0cf3136e5342",
"db_currency_id": "ca50a60c-1325-4dd4-8bdf-d6a54950a4d4",
"db_language_id": "20f1d822-9cca-49b4-af62-9239f63ea240",
"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-23T23:55:00.3712218+00:00"
},
"modified_dateutc": "2025-12-23T23:55:00.3712218+00:00"
},
"equipment_family_id": "0479b790-13b4-4732-9e33-143405ef3e38",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "65e7cd9e-a423-4e92-9a91-31d83f7b226d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9a1b670c-9fdb-4b82-9c1d-6a69fa2651b8",
"_parent_code": "sample string 6",
"sales_organization_id": "9a2f41e2-a211-4f4c-8881-83b6608be7d9",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "92f9ba32-8b9d-4a92-9c88-7274e386b341",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d1c5df9a-6eca-4b82-9ba6-0cf3136e5342",
"db_currency_id": "ca50a60c-1325-4dd4-8bdf-d6a54950a4d4",
"db_language_id": "20f1d822-9cca-49b4-af62-9239f63ea240",
"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-23T23:55:00.3712218+00:00"
},
"modified_dateutc": "2025-12-23T23:55:00.3712218+00:00"
},
"date_in_production_since": "2025-12-23T23:55:00.3712218+00:00",
"date_out_of_production_since": "2025-12-23T23:55:00.3712218+00:00",
"date_end_support": "2025-12-23T23:55:00.3712218+00:00",
"sales_organization_id": "db1b1e2e-fda1-4c83-b282-bd7e130e0c7f",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "92f9ba32-8b9d-4a92-9c88-7274e386b341",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d1c5df9a-6eca-4b82-9ba6-0cf3136e5342",
"db_currency_id": "ca50a60c-1325-4dd4-8bdf-d6a54950a4d4",
"db_language_id": "20f1d822-9cca-49b4-af62-9239f63ea240",
"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-23T23:55:00.3712218+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-23T23:55:00.3712218+00:00"
},
"project_status_id": "746ec544-00ea-4279-81fe-dc1dbf12e224",
"project_status_code": "sample string 10",
"project_status": {
"id": "628773bf-bc9f-4e0f-a0ba-05d315e596c5",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "b59b2b2b-1812-4eea-b1dd-dbd2687a160d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "92f9ba32-8b9d-4a92-9c88-7274e386b341",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d1c5df9a-6eca-4b82-9ba6-0cf3136e5342",
"db_currency_id": "ca50a60c-1325-4dd4-8bdf-d6a54950a4d4",
"db_language_id": "20f1d822-9cca-49b4-af62-9239f63ea240",
"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-23T23:55:00.3712218+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-23T23:55:00.3712218+00:00"
},
"company_id": "2f037e80-41fb-402a-a59b-fa6409bab261",
"company_code": "sample string 12",
"db_address_id": "3ad3fbca-f792-454f-a97e-b68fe4da16ec",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "c0e44f74-7a14-4aeb-bf70-76886fdd3d64",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "3983cd7b-fc0c-48d7-9eb2-d5a631dd979e",
"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-23T23:55:00.3712218+00:00",
"date_create": "2025-12-23T23:55:00.3712218+00:00",
"date_update": "2025-12-23T23:55:00.3712218+00:00",
"updated_by_user_id": "41bd7dbc-ff50-459c-b98e-2f3ecad81bc6",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-23T23:55:00.3712218+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-23T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-23T23:55:00.3712218+00:00",
"date_last_job": "2025-12-23T23:55:00.3712218+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-23T23:55:00.3712218+00:00",
"modified_dateutc": "2025-12-23T23:55:00.3712218+00:00",
"is_mobile_installation": true
},
"job_type_id": "611196ca-60ad-4886-a867-b9e1ea43976a",
"job_type_code": "sample string 7",
"job_type": {
"id": "5f28f32f-746c-4761-a9ec-c75257612232",
"name": "sample string 2",
"sales_organization_id": "77736f0b-0854-40ee-921f-c8a01178d7bf",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-23T23:55:00.3712218+00:00",
"code": "sample string 7"
},
"job_priority_id": "94187334-c1d4-4a33-98c0-e1d9055a2e6e",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "b06f61f4-8053-4a09-9e8d-b0f42ea3a6d8",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "8a86697c-affa-4ee7-95f6-9982c03c6dc9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "92f9ba32-8b9d-4a92-9c88-7274e386b341",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d1c5df9a-6eca-4b82-9ba6-0cf3136e5342",
"db_currency_id": "ca50a60c-1325-4dd4-8bdf-d6a54950a4d4",
"db_language_id": "20f1d822-9cca-49b4-af62-9239f63ea240",
"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-23T23:55:00.3712218+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-23T23:55:00.3712218+00:00"
},
"job_status_id": "d760e993-31ba-450e-b4fb-c4b8e123000d",
"job_status_code": "sample string 11",
"db_address_id": "c75cdec5-5689-4708-b96d-3de80426124b",
"contact_id": "5ae762bc-14de-49b9-9877-699d853a853f",
"requested_by_company_id": "0ef42f49-f58d-4850-a47d-cdca9be86db9",
"requested_by_contact_id": "3f465738-ef3e-47ed-80df-5385c3da8177",
"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-23T23:55:00.3712218+00:00",
"due_date": "2025-12-23T23:55:00.3712218+00:00",
"date_create": "2025-12-23T23:55:00.3712218+00:00",
"date_update": "2025-12-23T23:55:00.3712218+00:00",
"date_closed": "2025-12-23T23:55:00.3712218+00:00",
"suggested_user_id": "1c8463a2-93a9-4190-91d7-585ffc6dcc6a",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "b099e5c5-14dd-42b1-a0e8-79cb90822224",
"db_language_id": "17b87d10-90d5-49bd-8ef6-a9e00aa7c0a8",
"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-23T23:55:00.3712218+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "bd77ad9b-ce7b-4a5a-9032-67bfa4e58841",
"sales_organization": {
"id": "92f9ba32-8b9d-4a92-9c88-7274e386b341",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d1c5df9a-6eca-4b82-9ba6-0cf3136e5342",
"db_currency_id": "ca50a60c-1325-4dd4-8bdf-d6a54950a4d4",
"db_language_id": "20f1d822-9cca-49b4-af62-9239f63ea240",
"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-23T23:55:00.3712218+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "bc386454-e4d3-4f50-a2d3-5b8574ae3d75",
"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": "ca3d45f7-b2fb-404c-b157-bf907c43978b",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-23T23:55:00.3712218+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "3aa0000b-ac89-41ff-ab3c-056955aced63"
},
"suggested_date_start": "2025-12-23T23:55:00.3712218+00:00",
"skill_id": "67c8450a-552a-45cc-9ad7-e308f1d419f5",
"skill_code": "sample string 32",
"skill": {
"id": "08e336fd-e3c1-4c31-a7f5-2b4fb43c8ea9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "677f8e79-bde6-4d3a-886b-dfeedfb4f2b8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "92f9ba32-8b9d-4a92-9c88-7274e386b341",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d1c5df9a-6eca-4b82-9ba6-0cf3136e5342",
"db_currency_id": "ca50a60c-1325-4dd4-8bdf-d6a54950a4d4",
"db_language_id": "20f1d822-9cca-49b4-af62-9239f63ea240",
"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-23T23:55:00.3712218+00:00"
},
"modified_dateutc": "2025-12-23T23:55:00.3712218+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "68f2b769-314f-40c5-a529-2f4aee9aabed",
"date_reported_by_company": "2025-12-23T23:55:00.3712218+00:00",
"id2": 36,
"company_id": "760c8af5-8f4e-4cf4-abac-fe3d2eb0e11e",
"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": "e3412b5a-1a84-4884-9d1a-adc2b4e27da5",
"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-23T23:55:00.3712218+00:00"
},
"work_instruction_details_id": "b6418425-49f5-4c12-a399-15d145837d18",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "dc1c06d7-8b49-4d8c-ae03-76504052351a",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "ede3f4d8-4bf9-43d1-8224-57605ad31c76",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-23T23:55:00.3712218+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": "2cb34630-e47b-4572-a5cb-1ff68ffb01ce",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-23T23:55:00.3712218+00:00"
}