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": "07ec4351-d6e4-4bef-9b54-1a0c93630376",
"jobs_id": "32823e95-27bd-4c5a-b8fa-32cd26af4432",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "3f538b7d-57a7-47f6-a593-3173cc333537",
"_parent_id": "950084e1-f94f-4d98-a974-174c7a548f7a",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "cc9cd2a3-6afb-46f1-aa82-87ba946c74bf",
"project_reference_back_office": "sample string 5",
"project": {
"id": "d8764e94-c9ac-4120-bb34-95cdf2f21031",
"_parent_id": "a9fe561f-e7d0-4da6-95a7-41025906f4ad",
"root_parent_id": "5176a7b8-c853-400e-b352-8a751fd84731",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "0b48d2e7-67c4-4db9-9350-f7cfbc472701",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "e0cecd9b-a6e9-4438-a9a6-e546f6365e5c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2a4e9038-ccb2-4ec9-840a-8cdc02c7f852",
"_parent_code": "sample string 6",
"sales_organization_id": "39488a1c-7205-461b-bcc7-d7d9c9a12a83",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ae293cc3-7e22-433f-8038-632ac0fffe35",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fa0983fa-3b54-4501-9bf4-c2dc071300ff",
"db_currency_id": "d3c38ee0-65b6-4f06-83f5-36a3861686d3",
"db_language_id": "ada9f51d-9d55-4669-ae4a-8f9efd9f841d",
"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-05-09T01:32:14.8669463+00:00"
},
"modified_dateutc": "2025-05-09T01:32:14.8669463+00:00"
},
"equipment_model_id": "3946b896-af54-4f37-b94a-f7e26063b5ff",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "b84e6b30-cb3b-46d1-b27a-a500675d0d64",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "70205574-1842-4d02-aae6-5c9e90e580de",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "a8417a19-86fa-416e-815b-9cbf962eb620",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "bd2fc639-a518-4f3f-8a36-cc45c525d72e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ae293cc3-7e22-433f-8038-632ac0fffe35",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fa0983fa-3b54-4501-9bf4-c2dc071300ff",
"db_currency_id": "d3c38ee0-65b6-4f06-83f5-36a3861686d3",
"db_language_id": "ada9f51d-9d55-4669-ae4a-8f9efd9f841d",
"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-05-09T01:32:14.8669463+00:00"
},
"modified_dateutc": "2025-05-09T01:32:14.8669463+00:00"
},
"equipment_family_id": "b9c2f341-eb21-4366-9fde-18596578027e",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "e0cecd9b-a6e9-4438-a9a6-e546f6365e5c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2a4e9038-ccb2-4ec9-840a-8cdc02c7f852",
"_parent_code": "sample string 6",
"sales_organization_id": "39488a1c-7205-461b-bcc7-d7d9c9a12a83",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ae293cc3-7e22-433f-8038-632ac0fffe35",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fa0983fa-3b54-4501-9bf4-c2dc071300ff",
"db_currency_id": "d3c38ee0-65b6-4f06-83f5-36a3861686d3",
"db_language_id": "ada9f51d-9d55-4669-ae4a-8f9efd9f841d",
"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-05-09T01:32:14.8669463+00:00"
},
"modified_dateutc": "2025-05-09T01:32:14.8669463+00:00"
},
"date_in_production_since": "2025-05-09T01:32:14.8669463+00:00",
"date_out_of_production_since": "2025-05-09T01:32:14.8669463+00:00",
"date_end_support": "2025-05-09T01:32:14.8669463+00:00",
"sales_organization_id": "f640430a-b38c-488e-b219-7e340ba3dba0",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "ae293cc3-7e22-433f-8038-632ac0fffe35",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fa0983fa-3b54-4501-9bf4-c2dc071300ff",
"db_currency_id": "d3c38ee0-65b6-4f06-83f5-36a3861686d3",
"db_language_id": "ada9f51d-9d55-4669-ae4a-8f9efd9f841d",
"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-05-09T01:32:14.8669463+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-05-09T01:32:14.8669463+00:00"
},
"project_status_id": "e582451f-7bec-4ccd-93cc-d84be3801797",
"project_status_code": "sample string 10",
"project_status": {
"id": "b3627eae-5e7c-4a9b-9591-981b7b636e24",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "f729a346-44da-4f72-bfa8-bba018713235",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ae293cc3-7e22-433f-8038-632ac0fffe35",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fa0983fa-3b54-4501-9bf4-c2dc071300ff",
"db_currency_id": "d3c38ee0-65b6-4f06-83f5-36a3861686d3",
"db_language_id": "ada9f51d-9d55-4669-ae4a-8f9efd9f841d",
"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-05-09T01:32:14.8669463+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-05-09T01:32:14.8669463+00:00"
},
"company_id": "a1b76aa1-8ad2-42da-a32f-bb3c1f091162",
"company_code": "sample string 12",
"db_address_id": "46a3ce99-f85d-45d8-a364-2242d4aeb4da",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "9a4b85b9-ed09-46b9-bbc1-c06799a92c56",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "cd9e5152-bea5-4297-bb21-7e5c44ebab9c",
"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-05-09T01:32:14.8669463+00:00",
"date_create": "2025-05-09T01:32:14.8669463+00:00",
"date_update": "2025-05-09T01:32:14.8669463+00:00",
"updated_by_user_id": "194c5c5f-62b6-4f23-b886-5236e8ca6fee",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-05-09T01:32:14.8669463+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-05-09T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-05-09T01:32:14.8669463+00:00",
"date_last_job": "2025-05-09T01:32:14.8669463+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-05-09T01:32:14.8669463+00:00",
"modified_dateutc": "2025-05-09T01:32:14.8669463+00:00",
"is_mobile_installation": true
},
"job_type_id": "2ade98d0-a907-4e0a-8d04-ff5c97f17913",
"job_type_code": "sample string 7",
"job_type": {
"id": "49d4ef3f-c886-4d1a-ae9f-cceea5786035",
"name": "sample string 2",
"sales_organization_id": "df377701-4b23-42c9-b5d9-2e16ebac20b0",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-05-09T01:32:14.8669463+00:00",
"code": "sample string 7"
},
"job_priority_id": "860c727b-711d-4a3e-bef5-f40415dbfbde",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "3b5fa9a8-a908-47f9-bd71-d05a1b5f2826",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "1a02985f-8b75-4e30-aeee-af0e936bf18a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ae293cc3-7e22-433f-8038-632ac0fffe35",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fa0983fa-3b54-4501-9bf4-c2dc071300ff",
"db_currency_id": "d3c38ee0-65b6-4f06-83f5-36a3861686d3",
"db_language_id": "ada9f51d-9d55-4669-ae4a-8f9efd9f841d",
"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-05-09T01:32:14.8669463+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-05-09T01:32:14.8669463+00:00"
},
"job_status_id": "4cf5b929-00cd-4081-8430-65598937cd59",
"job_status_code": "sample string 11",
"db_address_id": "c1a26990-952a-4a83-8cd9-5014a70fc8e1",
"contact_id": "6c554bc4-5de3-4317-b035-d3735354d098",
"requested_by_company_id": "9b66ed94-c134-495a-a9eb-cb98f2020464",
"requested_by_contact_id": "c3ec65c2-0756-4fb6-91da-e09b1403eb8f",
"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-05-09T01:32:14.8669463+00:00",
"due_date": "2025-05-09T01:32:14.8669463+00:00",
"date_create": "2025-05-09T01:32:14.8669463+00:00",
"date_update": "2025-05-09T01:32:14.8669463+00:00",
"date_closed": "2025-05-09T01:32:14.8669463+00:00",
"suggested_user_id": "70570f55-2d37-43be-aac8-e03add4eb2dd",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "3963f372-e39f-469a-940a-59a7df629b35",
"db_language_id": "b27a72ac-a553-4d59-9775-ed2e08becc67",
"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-05-09T01:32:14.8669463+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "f55a287b-e990-4f0c-8468-736dbc15dc80",
"sales_organization": {
"id": "ae293cc3-7e22-433f-8038-632ac0fffe35",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fa0983fa-3b54-4501-9bf4-c2dc071300ff",
"db_currency_id": "d3c38ee0-65b6-4f06-83f5-36a3861686d3",
"db_language_id": "ada9f51d-9d55-4669-ae4a-8f9efd9f841d",
"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-05-09T01:32:14.8669463+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "b5316c8a-a327-45ac-99c9-632933a19c8d",
"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": "0b6f29e3-2e95-4f71-b4b7-62aa584e0531",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-05-09T01:32:14.8669463+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "64c410e4-5aaf-4eb7-8d02-3aa2f48e15d4"
},
"suggested_date_start": "2025-05-09T01:32:14.8669463+00:00",
"skill_id": "4f365551-ebd1-4e4b-ac2d-86c23b17583f",
"skill_code": "sample string 32",
"skill": {
"id": "f8e0f14c-4c24-49b1-9996-9b435e8f2de7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "3f1e45d5-08ef-478c-9296-994a81de30b1",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ae293cc3-7e22-433f-8038-632ac0fffe35",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fa0983fa-3b54-4501-9bf4-c2dc071300ff",
"db_currency_id": "d3c38ee0-65b6-4f06-83f5-36a3861686d3",
"db_language_id": "ada9f51d-9d55-4669-ae4a-8f9efd9f841d",
"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-05-09T01:32:14.8669463+00:00"
},
"modified_dateutc": "2025-05-09T01:32:14.8669463+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "f55ed4b5-9980-4c92-93c6-5770e6d7f8be",
"date_reported_by_company": "2025-05-09T01:32:14.8669463+00:00",
"id2": 36,
"company_id": "05223769-1883-462d-9258-d819dd8d7a97",
"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": "17a8c5db-15a2-40b5-8548-1db355ef9590",
"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-05-09T01:32:14.8669463+00:00"
},
"work_instruction_details_id": "b35b791d-980a-46b8-91d1-57d601ea8ed7",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "535f152c-8e2e-46e3-b31b-a0a3798a7f7f",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "2f8db057-2f47-4643-88ed-d20fb0bcb0af",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-05-09T01:32:14.8669463+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": "4b5d70b4-58cd-4566-826f-7f5da390bec2",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-05-09T01:32:14.8669463+00:00"
}