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": "dd02c329-8d8a-4a78-8909-ade2b972b94f",
"jobs_id": "abdf5515-26fb-4269-a67a-3e9992e06d86",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "b0dd9c72-662c-4bc2-8d16-86168f9aa594",
"_parent_id": "1fe2298d-2394-4f55-9b63-a8359c4f86be",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "80f39f80-701d-4d5e-b308-d764539e50a7",
"project_reference_back_office": "sample string 5",
"project": {
"id": "5d4d533c-ea4d-433e-a1b4-5f30f7e41138",
"_parent_id": "5fddc7fb-3614-4293-9ded-844884eead2e",
"root_parent_id": "8a8d72b2-9368-42bd-9a8a-26ae3d59d045",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "59692e2f-8ef1-4d34-9a52-70dd4a9e0711",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "262fb4fd-46e3-4c6d-8d27-15c2d97cfbce",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "04372927-4033-41ae-aa6d-da6204fda3c7",
"_parent_code": "sample string 6",
"sales_organization_id": "ad9ca17a-2c75-410c-9c54-0c7a02c47022",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e47ff67a-43e8-47b3-a0d8-43aa0d6fbf64",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0dabb3a6-24b9-4e4a-91be-41ca6cc799d0",
"db_currency_id": "f8686aec-d596-4326-bd94-e7ddc9f960d3",
"db_language_id": "06246568-b77c-4580-8e28-3a97e4dec071",
"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-07-11T13:01:40.8475866+00:00"
},
"modified_dateutc": "2025-07-11T13:01:40.8475866+00:00"
},
"equipment_model_id": "ad10a8d7-6f1c-4a62-9116-bb3ae2da68ad",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "4e603f4c-17e0-4496-a2c3-9d660df0abdd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "0e5c14c4-3af1-41e0-aa0b-3ae0b8cab841",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "a52d0613-9c52-445d-8b42-48fc09b4ac7d",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "8ddf5284-4a21-4920-8526-dcabbc353a29",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e47ff67a-43e8-47b3-a0d8-43aa0d6fbf64",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0dabb3a6-24b9-4e4a-91be-41ca6cc799d0",
"db_currency_id": "f8686aec-d596-4326-bd94-e7ddc9f960d3",
"db_language_id": "06246568-b77c-4580-8e28-3a97e4dec071",
"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-07-11T13:01:40.8475866+00:00"
},
"modified_dateutc": "2025-07-11T13:01:40.8475866+00:00"
},
"equipment_family_id": "9d64ed47-c58a-4463-8a4c-077c9b20077f",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "262fb4fd-46e3-4c6d-8d27-15c2d97cfbce",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "04372927-4033-41ae-aa6d-da6204fda3c7",
"_parent_code": "sample string 6",
"sales_organization_id": "ad9ca17a-2c75-410c-9c54-0c7a02c47022",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e47ff67a-43e8-47b3-a0d8-43aa0d6fbf64",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0dabb3a6-24b9-4e4a-91be-41ca6cc799d0",
"db_currency_id": "f8686aec-d596-4326-bd94-e7ddc9f960d3",
"db_language_id": "06246568-b77c-4580-8e28-3a97e4dec071",
"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-07-11T13:01:40.8475866+00:00"
},
"modified_dateutc": "2025-07-11T13:01:40.8475866+00:00"
},
"date_in_production_since": "2025-07-11T13:01:40.8475866+00:00",
"date_out_of_production_since": "2025-07-11T13:01:40.8475866+00:00",
"date_end_support": "2025-07-11T13:01:40.8475866+00:00",
"sales_organization_id": "7c1c28b8-bcd1-4738-97d6-94be42f141cb",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "e47ff67a-43e8-47b3-a0d8-43aa0d6fbf64",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0dabb3a6-24b9-4e4a-91be-41ca6cc799d0",
"db_currency_id": "f8686aec-d596-4326-bd94-e7ddc9f960d3",
"db_language_id": "06246568-b77c-4580-8e28-3a97e4dec071",
"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-07-11T13:01:40.8475866+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-07-11T13:01:40.8632107+00:00"
},
"project_status_id": "1b27bef3-7bde-48c4-8c5c-26dbe6b4c9e4",
"project_status_code": "sample string 10",
"project_status": {
"id": "848c3c00-3db8-4c09-9e15-2defab76b2bf",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "a96be22a-1f58-4edf-b026-04cf9d7c9069",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e47ff67a-43e8-47b3-a0d8-43aa0d6fbf64",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0dabb3a6-24b9-4e4a-91be-41ca6cc799d0",
"db_currency_id": "f8686aec-d596-4326-bd94-e7ddc9f960d3",
"db_language_id": "06246568-b77c-4580-8e28-3a97e4dec071",
"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-07-11T13:01:40.8475866+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-07-11T13:01:40.8632107+00:00"
},
"company_id": "8d36270e-991e-43c6-a28f-d616b5043832",
"company_code": "sample string 12",
"db_address_id": "1e8327a2-f103-4a9a-8c13-20725001a5f6",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "dd871d9b-315e-4441-aa24-5a19f881ec8f",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "e9ab0a82-6a51-4413-a768-2661e7254138",
"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-07-11T13:01:40.8632107+00:00",
"date_create": "2025-07-11T13:01:40.8632107+00:00",
"date_update": "2025-07-11T13:01:40.8632107+00:00",
"updated_by_user_id": "7ea05d22-d5a4-428f-a357-40b5788c4a3e",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-07-11T13:01:40.8632107+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-07-11T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-07-11T13:01:40.8632107+00:00",
"date_last_job": "2025-07-11T13:01:40.8632107+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-07-11T13:01:40.8632107+00:00",
"modified_dateutc": "2025-07-11T13:01:40.8632107+00:00",
"is_mobile_installation": true
},
"job_type_id": "b15c7524-c072-42d7-b781-b6f439aa07ff",
"job_type_code": "sample string 7",
"job_type": {
"id": "a360d54c-dfdf-4beb-8454-741e6b2671bd",
"name": "sample string 2",
"sales_organization_id": "114962d0-56cd-4e53-aad8-ef0121b2857c",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-07-11T13:01:40.8632107+00:00",
"code": "sample string 7"
},
"job_priority_id": "7cd1d3b9-7078-40cb-afca-c5a7692bc60e",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "21c7341a-044f-49d0-9204-15763f93a101",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "5e658ee0-0e35-4502-88e8-63d8557a6628",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e47ff67a-43e8-47b3-a0d8-43aa0d6fbf64",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0dabb3a6-24b9-4e4a-91be-41ca6cc799d0",
"db_currency_id": "f8686aec-d596-4326-bd94-e7ddc9f960d3",
"db_language_id": "06246568-b77c-4580-8e28-3a97e4dec071",
"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-07-11T13:01:40.8475866+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-07-11T13:01:40.8632107+00:00"
},
"job_status_id": "a1a931a7-9f68-4c9a-93ed-c999061b4327",
"job_status_code": "sample string 11",
"db_address_id": "940abfd0-cf14-4479-af8a-8c28d7be2856",
"contact_id": "9c22dddd-bc2e-4cab-be00-354bb19803bc",
"requested_by_company_id": "3b561e72-5813-4003-973c-44645dd3e58d",
"requested_by_contact_id": "e4df9b0e-d7c9-4298-afed-60fcbe4a2afb",
"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-07-11T13:01:40.8632107+00:00",
"due_date": "2025-07-11T13:01:40.8632107+00:00",
"date_create": "2025-07-11T13:01:40.8632107+00:00",
"date_update": "2025-07-11T13:01:40.8632107+00:00",
"date_closed": "2025-07-11T13:01:40.8632107+00:00",
"suggested_user_id": "88107b1f-6900-484c-8412-1f999164c25b",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "8f80e944-6e13-4761-8437-7ddbbbd47bbb",
"db_language_id": "32c675cb-9798-4e39-b917-b6657e2011b1",
"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-07-11T13:01:40.8632107+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "95521d52-c394-435d-9517-23be1c3738c4",
"sales_organization": {
"id": "e47ff67a-43e8-47b3-a0d8-43aa0d6fbf64",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0dabb3a6-24b9-4e4a-91be-41ca6cc799d0",
"db_currency_id": "f8686aec-d596-4326-bd94-e7ddc9f960d3",
"db_language_id": "06246568-b77c-4580-8e28-3a97e4dec071",
"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-07-11T13:01:40.8475866+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "34a8e9fe-7ee7-4eae-8fb6-0cb5476a6086",
"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": "a7e47f5e-b48e-42c9-ac03-eccd24845375",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-07-11T13:01:40.8632107+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "6eebe20d-f01e-4e76-83c2-4e44d11d9cae"
},
"suggested_date_start": "2025-07-11T13:01:40.8632107+00:00",
"skill_id": "07714d63-d27a-4ba2-80d6-0197f59f2729",
"skill_code": "sample string 32",
"skill": {
"id": "6f9bb176-11a6-4ef0-96bb-062fc5acb9b7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "ef268e0e-6297-4ad6-b22d-08a7c7ac6f2d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e47ff67a-43e8-47b3-a0d8-43aa0d6fbf64",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0dabb3a6-24b9-4e4a-91be-41ca6cc799d0",
"db_currency_id": "f8686aec-d596-4326-bd94-e7ddc9f960d3",
"db_language_id": "06246568-b77c-4580-8e28-3a97e4dec071",
"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-07-11T13:01:40.8475866+00:00"
},
"modified_dateutc": "2025-07-11T13:01:40.8632107+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "dd38811f-a9b0-45c9-b16d-f4d1b58c9e03",
"date_reported_by_company": "2025-07-11T13:01:40.8632107+00:00",
"id2": 36,
"company_id": "83cb108c-d205-40d9-a63d-324ff28c37b1",
"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": "b31d2bea-a7b8-4eb3-9ca3-961a187d9fbe",
"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-07-11T13:01:40.8632107+00:00"
},
"work_instruction_details_id": "02bfb045-b93d-4bb3-8f88-a5df4df22289",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "e6cacaae-d27a-4ed0-8c89-f8fad6a56ab3",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "8cd3316d-c2af-42a8-b13f-56cbd24a67b2",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-07-11T13:01:40.8632107+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": "0c14b336-8c77-4536-8951-845cfb165c30",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-07-11T13:01:40.8632107+00:00"
}