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": "00dfe02a-6044-43ce-9597-fc4b30ba411e",
"jobs_id": "4d5face1-7f07-4f11-bd29-580f30927cb9",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "a610c286-c49f-414d-9fa8-d3a5569607dd",
"_parent_id": "0b07e828-06c1-4841-b040-2eece5d0f367",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "354ad6cb-6bb1-4b79-927e-900895b2fa6a",
"project_reference_back_office": "sample string 5",
"project": {
"id": "80c179ae-02b8-43bb-9e7a-bfeb81e46d35",
"_parent_id": "fb0e2d93-f9f6-4178-855d-b8014cb053f7",
"root_parent_id": "1eabbd1f-f4a8-4345-a219-6818b259bdf4",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "5f9e562f-9636-4231-87f3-e02dc9fa1691",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "84aea4a8-fef9-4055-8941-af86c989563d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2cac203e-0d66-4059-914f-51d56f2c996d",
"_parent_code": "sample string 6",
"sales_organization_id": "e0d0556d-29ab-404a-b90e-7eca33e10d11",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f64a1cc5-2767-4633-bb87-f5284420f745",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "afe9e3b5-eef5-4e95-809a-da276ae84178",
"db_currency_id": "94b9f2b2-2cf8-4c74-ab03-e517bfb5192d",
"db_language_id": "4db89137-eb30-4390-a519-54df4276b38a",
"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-10-20T05:28:30.3712004+00:00"
},
"modified_dateutc": "2026-10-20T05:28:30.3712004+00:00"
},
"equipment_model_id": "4d7fa80f-775d-4d95-bc0d-508da4c68023",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "47422ed5-9639-4cee-9144-2d132d408bdc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "797e5821-63bf-4de5-a5c5-c1bcb2ac2779",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "784be7eb-295b-4919-84f5-b895c058427d",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "12934ad5-fe59-4a07-a0d5-2026c0d413f7",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f64a1cc5-2767-4633-bb87-f5284420f745",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "afe9e3b5-eef5-4e95-809a-da276ae84178",
"db_currency_id": "94b9f2b2-2cf8-4c74-ab03-e517bfb5192d",
"db_language_id": "4db89137-eb30-4390-a519-54df4276b38a",
"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-10-20T05:28:30.3712004+00:00"
},
"modified_dateutc": "2026-10-20T05:28:30.3842249+00:00"
},
"equipment_family_id": "295f93a6-4c90-400f-a8b1-3e817ac48595",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "84aea4a8-fef9-4055-8941-af86c989563d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2cac203e-0d66-4059-914f-51d56f2c996d",
"_parent_code": "sample string 6",
"sales_organization_id": "e0d0556d-29ab-404a-b90e-7eca33e10d11",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f64a1cc5-2767-4633-bb87-f5284420f745",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "afe9e3b5-eef5-4e95-809a-da276ae84178",
"db_currency_id": "94b9f2b2-2cf8-4c74-ab03-e517bfb5192d",
"db_language_id": "4db89137-eb30-4390-a519-54df4276b38a",
"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-10-20T05:28:30.3712004+00:00"
},
"modified_dateutc": "2026-10-20T05:28:30.3712004+00:00"
},
"date_in_production_since": "2026-10-20T05:28:30.3842249+00:00",
"date_out_of_production_since": "2026-10-20T05:28:30.3842249+00:00",
"date_end_support": "2026-10-20T05:28:30.3842249+00:00",
"sales_organization_id": "0e6c5262-a291-4791-adff-cc0acb96ab88",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "f64a1cc5-2767-4633-bb87-f5284420f745",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "afe9e3b5-eef5-4e95-809a-da276ae84178",
"db_currency_id": "94b9f2b2-2cf8-4c74-ab03-e517bfb5192d",
"db_language_id": "4db89137-eb30-4390-a519-54df4276b38a",
"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-10-20T05:28:30.3712004+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-10-20T05:28:30.4154248+00:00"
},
"project_status_id": "9a869e55-d12f-4386-b2b6-66f9d75add00",
"project_status_code": "sample string 10",
"project_status": {
"id": "1151827b-1c7f-43ff-ba5f-73cb7f8a1035",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "1a13d2c8-3c8e-4eb2-be0b-8c4485a31093",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f64a1cc5-2767-4633-bb87-f5284420f745",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "afe9e3b5-eef5-4e95-809a-da276ae84178",
"db_currency_id": "94b9f2b2-2cf8-4c74-ab03-e517bfb5192d",
"db_language_id": "4db89137-eb30-4390-a519-54df4276b38a",
"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-10-20T05:28:30.3712004+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-20T05:28:30.4154248+00:00"
},
"company_id": "ccb106a0-09b3-4095-b8c0-ad0d7b43ec31",
"company_code": "sample string 12",
"db_address_id": "09202cd4-36ec-477e-b923-383a5449e5e2",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "33c9add5-f209-433f-a4ac-3526dc1303d8",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "cba7657d-33a4-4f5b-8c27-e8d536cfe9fb",
"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-10-20T05:28:30.4311033+00:00",
"date_create": "2026-10-20T05:28:30.4311033+00:00",
"date_update": "2026-10-20T05:28:30.4311033+00:00",
"updated_by_user_id": "4d408de7-303b-4aa2-a379-915e80ae84f4",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-20T05:28:30.4311033+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-10-20T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-20T05:28:30.4311033+00:00",
"date_last_job": "2026-10-20T05:28:30.4311033+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-20T05:28:30.4311033+00:00",
"modified_dateutc": "2026-10-20T05:28:30.4311033+00:00",
"is_mobile_installation": true
},
"job_type_id": "e90ab205-84f2-4e83-bda0-9884e73267cd",
"job_type_code": "sample string 7",
"job_type": {
"id": "98aaee6f-67cd-4d3f-ac4c-0f92d01c48d8",
"name": "sample string 2",
"sales_organization_id": "6ae0d499-af1f-4a7d-a2ef-43c4f16e83de",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-20T05:28:30.4311033+00:00",
"code": "sample string 7"
},
"job_priority_id": "778ffdf7-cc0c-470d-8ca5-7efd1bcd6ea0",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "c588e4ef-3422-4476-8855-2dcd0a0c735d",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "29e7f4e3-43d6-42a4-8c1b-f5434d1a3332",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f64a1cc5-2767-4633-bb87-f5284420f745",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "afe9e3b5-eef5-4e95-809a-da276ae84178",
"db_currency_id": "94b9f2b2-2cf8-4c74-ab03-e517bfb5192d",
"db_language_id": "4db89137-eb30-4390-a519-54df4276b38a",
"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-10-20T05:28:30.3712004+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-20T05:28:30.4311033+00:00"
},
"job_status_id": "e0b123e5-055e-4ff8-8676-9339a5a6c4a8",
"job_status_code": "sample string 11",
"db_address_id": "f18b6e00-7942-420d-8435-0e03eb769eb3",
"contact_id": "34fdafd2-a98f-4c0b-b10c-d179c84deac2",
"requested_by_company_id": "dd31bfc2-4285-4833-bfcd-378932c8647e",
"requested_by_contact_id": "9b20a219-62a2-4d7a-8c0d-d444bad1edab",
"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-10-20T05:28:30.4311033+00:00",
"due_date": "2026-10-20T05:28:30.4311033+00:00",
"date_create": "2026-10-20T05:28:30.4311033+00:00",
"date_update": "2026-10-20T05:28:30.4311033+00:00",
"date_closed": "2026-10-20T05:28:30.4311033+00:00",
"suggested_user_id": "d5b0ecfb-37d0-4aea-b9b0-739f7ffa13c6",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "7363f8a7-90e2-4f35-b3ec-c53c1da1bd39",
"db_language_id": "e36cf0eb-17b0-4044-b75b-74f414449033",
"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-10-20T05:28:30.4311033+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "c3fce553-02da-48eb-88b8-dd5b3b8a71c1",
"sales_organization": {
"id": "f64a1cc5-2767-4633-bb87-f5284420f745",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "afe9e3b5-eef5-4e95-809a-da276ae84178",
"db_currency_id": "94b9f2b2-2cf8-4c74-ab03-e517bfb5192d",
"db_language_id": "4db89137-eb30-4390-a519-54df4276b38a",
"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-10-20T05:28:30.3712004+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "42151f07-215c-420c-ba4a-bce924d216ff",
"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": "5bf07202-1a85-4b44-bc63-de50303c4412",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-20T05:28:30.4311033+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "877e47c9-5ae4-4ffc-815e-a484dc892e45"
},
"suggested_date_start": "2026-10-20T05:28:30.4311033+00:00",
"skill_id": "2c7fc871-c60b-4713-81f2-950217a52e11",
"skill_code": "sample string 32",
"skill": {
"id": "06769d4c-9b4c-4fb5-b432-46e1ab624ce8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "179e844d-68e9-42a9-8a6a-2fd09f0e682f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f64a1cc5-2767-4633-bb87-f5284420f745",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "afe9e3b5-eef5-4e95-809a-da276ae84178",
"db_currency_id": "94b9f2b2-2cf8-4c74-ab03-e517bfb5192d",
"db_language_id": "4db89137-eb30-4390-a519-54df4276b38a",
"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-10-20T05:28:30.3712004+00:00"
},
"modified_dateutc": "2026-10-20T05:28:30.4311033+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "75fdb2b7-97dc-4f7a-b298-9fd055493eef",
"date_reported_by_company": "2026-10-20T05:28:30.4311033+00:00",
"id2": 36,
"company_id": "24545c5d-a7ac-4c0f-b09b-2d34dc2847bc",
"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": "0ae582fa-7dec-4b40-a8e7-99b5f38cb3c9",
"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-10-20T05:28:30.4506997+00:00"
},
"work_instruction_details_id": "872f7ff4-f2a3-4fd7-86b3-b19126afca47",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "95fb43bd-bc08-4080-83ea-88c260579c6b",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "797edacd-6d03-4263-8c6c-7b95d3025eb3",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-20T05:28:30.4506997+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": "faffebd5-aab2-4d01-9870-35ac2795ef3c",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-20T05:28:30.4506997+00:00"
}