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": "dc6fe275-e2bb-4ce9-a846-2c2e4e02cbea",
"jobs_id": "6a24bf35-4b33-4270-9c88-d82718bccc60",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "63575383-d882-45f4-a0e8-fc542239309a",
"_parent_id": "2db79b67-63f5-416a-803c-936376b47952",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "78805c3d-dc75-474c-9204-961812d05505",
"project_reference_back_office": "sample string 5",
"project": {
"id": "ffd01d14-62a0-4814-a97d-ba44dcef11cf",
"_parent_id": "a279de1a-9c7c-479c-86d3-5b82312080e3",
"root_parent_id": "5bb43931-a310-42ef-a8a3-8d1f22f91418",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "c17c9e72-cf64-4ba2-98f6-c3bf8f8ebf3c",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "eaf79a76-ef00-4fff-a3cc-a75af4aba69d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "072ac2de-6a7d-4db5-8d2c-491e73b89e12",
"_parent_code": "sample string 6",
"sales_organization_id": "a027c0ee-3c8e-4119-bc1c-ac596cb32d78",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3615eb4f-839b-4660-9953-f7d7605f6bc0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "de1ab46f-5b8f-4a86-b73a-091899730432",
"db_currency_id": "6f52756c-be41-41cb-ae11-66dd27db37e8",
"db_language_id": "e48f3687-645c-4b7e-869d-54d9a60570a7",
"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-01-16T18:02:16.9974704+00:00"
},
"modified_dateutc": "2026-01-16T18:02:16.9974704+00:00"
},
"equipment_model_id": "67d229a4-9cb9-4f4c-9fdd-bea385449ce0",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "09bacb9b-e6f6-483f-ad5a-f103bcd7aaa3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "88f1bdee-3bc7-4928-9ee0-6c8d4378af56",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "c8346b4a-36c8-40df-beb7-d0c0b5a7c14c",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "51d4e693-b26c-4699-ba65-3d5de30d4892",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3615eb4f-839b-4660-9953-f7d7605f6bc0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "de1ab46f-5b8f-4a86-b73a-091899730432",
"db_currency_id": "6f52756c-be41-41cb-ae11-66dd27db37e8",
"db_language_id": "e48f3687-645c-4b7e-869d-54d9a60570a7",
"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-01-16T18:02:16.9974704+00:00"
},
"modified_dateutc": "2026-01-16T18:02:16.9974704+00:00"
},
"equipment_family_id": "1f1e32d4-2716-421d-b0c4-6bc1018ee054",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "eaf79a76-ef00-4fff-a3cc-a75af4aba69d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "072ac2de-6a7d-4db5-8d2c-491e73b89e12",
"_parent_code": "sample string 6",
"sales_organization_id": "a027c0ee-3c8e-4119-bc1c-ac596cb32d78",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3615eb4f-839b-4660-9953-f7d7605f6bc0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "de1ab46f-5b8f-4a86-b73a-091899730432",
"db_currency_id": "6f52756c-be41-41cb-ae11-66dd27db37e8",
"db_language_id": "e48f3687-645c-4b7e-869d-54d9a60570a7",
"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-01-16T18:02:16.9974704+00:00"
},
"modified_dateutc": "2026-01-16T18:02:16.9974704+00:00"
},
"date_in_production_since": "2026-01-16T18:02:16.9974704+00:00",
"date_out_of_production_since": "2026-01-16T18:02:16.9974704+00:00",
"date_end_support": "2026-01-16T18:02:16.9974704+00:00",
"sales_organization_id": "80740eab-aec2-48de-b9ca-b96473cf7cea",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "3615eb4f-839b-4660-9953-f7d7605f6bc0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "de1ab46f-5b8f-4a86-b73a-091899730432",
"db_currency_id": "6f52756c-be41-41cb-ae11-66dd27db37e8",
"db_language_id": "e48f3687-645c-4b7e-869d-54d9a60570a7",
"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-01-16T18:02:16.9974704+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-01-16T18:02:16.9974704+00:00"
},
"project_status_id": "242661dc-6350-4017-91c2-0560e82542e0",
"project_status_code": "sample string 10",
"project_status": {
"id": "e8ddfd91-4bfe-40b7-8af5-366b75f4481f",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "de80d5e4-1122-4477-9f69-83de4605c5da",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3615eb4f-839b-4660-9953-f7d7605f6bc0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "de1ab46f-5b8f-4a86-b73a-091899730432",
"db_currency_id": "6f52756c-be41-41cb-ae11-66dd27db37e8",
"db_language_id": "e48f3687-645c-4b7e-869d-54d9a60570a7",
"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-01-16T18:02:16.9974704+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-16T18:02:16.9974704+00:00"
},
"company_id": "7d564791-b4a6-4e3b-b579-265e4f2fba9f",
"company_code": "sample string 12",
"db_address_id": "e160cd19-6534-4512-b7c6-f050ca54fc7d",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "5285d33f-4041-477c-a906-5f76f41be59b",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "6affc039-5a06-4d1d-a032-c8fba5f91ac7",
"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-01-16T18:02:16.9974704+00:00",
"date_create": "2026-01-16T18:02:16.9974704+00:00",
"date_update": "2026-01-16T18:02:16.9974704+00:00",
"updated_by_user_id": "e0457bd7-0684-4a4b-b8a9-c6779ec9876c",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-16T18:02:16.9974704+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-01-16T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-16T18:02:16.9974704+00:00",
"date_last_job": "2026-01-16T18:02:16.9974704+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-16T18:02:16.9974704+00:00",
"modified_dateutc": "2026-01-16T18:02:16.9974704+00:00",
"is_mobile_installation": true
},
"job_type_id": "c0d10a99-f001-4adf-8bf1-398cbee41d2c",
"job_type_code": "sample string 7",
"job_type": {
"id": "6617d262-668b-4255-a71f-a42340ab6511",
"name": "sample string 2",
"sales_organization_id": "549b5c91-8b16-4a8a-bce3-c38e08ce9092",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-16T18:02:16.9974704+00:00",
"code": "sample string 7"
},
"job_priority_id": "58512a72-8717-4549-9286-b5a341a0cf6b",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "e81902e9-126a-416e-96c1-dcc4a2582d19",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "3cbc3974-32b7-474b-8e0e-5b7eccf781e9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3615eb4f-839b-4660-9953-f7d7605f6bc0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "de1ab46f-5b8f-4a86-b73a-091899730432",
"db_currency_id": "6f52756c-be41-41cb-ae11-66dd27db37e8",
"db_language_id": "e48f3687-645c-4b7e-869d-54d9a60570a7",
"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-01-16T18:02:16.9974704+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-16T18:02:16.9974704+00:00"
},
"job_status_id": "20575b71-772d-4084-a7aa-28976c7c2930",
"job_status_code": "sample string 11",
"db_address_id": "8f9c30e8-c1dd-4b63-adc1-bbb639b3c947",
"contact_id": "85eade1b-bf16-4c65-b7aa-36024aff6353",
"requested_by_company_id": "adabbe2a-cc8e-431a-93b1-f8122eb872b7",
"requested_by_contact_id": "dfef9e8d-7e3d-4541-aa30-0be65540659d",
"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-01-16T18:02:16.9974704+00:00",
"due_date": "2026-01-16T18:02:16.9974704+00:00",
"date_create": "2026-01-16T18:02:16.9974704+00:00",
"date_update": "2026-01-16T18:02:16.9974704+00:00",
"date_closed": "2026-01-16T18:02:16.9974704+00:00",
"suggested_user_id": "a3a03bb7-6e25-4836-b81a-f76313c154eb",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "6841ad6d-b6d3-40e8-9b01-41eae6bf816c",
"db_language_id": "29e89609-a100-4b41-931c-30e448fc51d6",
"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-01-16T18:02:16.9974704+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "6456e524-803a-487c-8c7a-cd450d111d8e",
"sales_organization": {
"id": "3615eb4f-839b-4660-9953-f7d7605f6bc0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "de1ab46f-5b8f-4a86-b73a-091899730432",
"db_currency_id": "6f52756c-be41-41cb-ae11-66dd27db37e8",
"db_language_id": "e48f3687-645c-4b7e-869d-54d9a60570a7",
"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-01-16T18:02:16.9974704+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "f6e1e329-d9cd-44eb-9091-62175807b0a4",
"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": "42c2fb14-a5d4-4979-9a4c-89199b13a96f",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-16T18:02:16.9974704+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "bfe600cf-97ff-4ce2-9745-1f3b0a47b4e1"
},
"suggested_date_start": "2026-01-16T18:02:16.9974704+00:00",
"skill_id": "169ed879-70f5-4cc2-9c7f-027c86eeb336",
"skill_code": "sample string 32",
"skill": {
"id": "ea109636-7480-41e2-a07d-b31c41cbe8a2",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "3af2550a-0c6d-4722-8934-5ecf761f03d9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3615eb4f-839b-4660-9953-f7d7605f6bc0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "de1ab46f-5b8f-4a86-b73a-091899730432",
"db_currency_id": "6f52756c-be41-41cb-ae11-66dd27db37e8",
"db_language_id": "e48f3687-645c-4b7e-869d-54d9a60570a7",
"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-01-16T18:02:16.9974704+00:00"
},
"modified_dateutc": "2026-01-16T18:02:16.9974704+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "73e970e1-fc26-4d27-9702-032877a3aa6e",
"date_reported_by_company": "2026-01-16T18:02:16.9974704+00:00",
"id2": 36,
"company_id": "f1ab8f12-4a9c-4939-ba57-aecc23964854",
"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": "bb2ef10c-c25f-4587-889f-1fde0f1dfbf5",
"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-01-16T18:02:16.9974704+00:00"
},
"work_instruction_details_id": "dc9d83f9-e4aa-4019-840a-8284398b6d37",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "81ae950c-0e93-4b88-b061-a71bf6302016",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "61095101-47db-475e-aee2-5e9238a14842",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-16T18:02:16.9974704+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": "8c93ae70-2741-436d-8180-30f0074951a2",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-16T18:02:16.9974704+00:00"
}