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": "ecf5c453-e1fb-4a2b-9c11-d53e649ce268",
"jobs_id": "42062c62-1414-457e-bbfb-2ff488345290",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "7c3a8f4f-721d-4371-866c-148163b69690",
"_parent_id": "a5a38532-0281-4b4b-b366-38ac24b43729",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "c6c3de95-035e-409d-83f3-a68ee9100b4b",
"project_reference_back_office": "sample string 5",
"project": {
"id": "77bfac8a-3ffa-42e6-afcf-3765ae116abf",
"_parent_id": "41eda1c8-42e0-4b89-8f3b-2a904b317646",
"root_parent_id": "d60f2d9d-9bc8-41a3-a799-8e86d1656e16",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "04aa4701-da70-4cfb-85d7-6145f8697e9b",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "6db9275d-f4fc-45b0-8a81-52cc3182832a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f2c5d7f5-9227-49cc-98a8-20525a7c2e85",
"_parent_code": "sample string 6",
"sales_organization_id": "5ac7c776-cefc-4899-94fb-c140768a95ba",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d75c859c-1ebe-4380-a19a-89e26ba3a4d5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3fc6c446-d172-43bd-bd06-887a527db920",
"db_currency_id": "f0fe69cb-aed0-41be-b694-2bc550e6a516",
"db_language_id": "238caf89-d4ec-41f2-bfc2-e4cfcf51d590",
"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-02-21T09:57:28.9441318+00:00"
},
"modified_dateutc": "2026-02-21T09:57:28.9441318+00:00"
},
"equipment_model_id": "46c48b81-41a0-4ab4-b018-0545893454fe",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "d843aeae-eca0-415c-ad5c-7b367aaa66c4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "27217179-064c-417f-86d8-e5070a427951",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "b763d986-b13a-4747-86f4-99c724ec8805",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "1710cf37-1a16-4b5c-87b2-6094e8739509",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d75c859c-1ebe-4380-a19a-89e26ba3a4d5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3fc6c446-d172-43bd-bd06-887a527db920",
"db_currency_id": "f0fe69cb-aed0-41be-b694-2bc550e6a516",
"db_language_id": "238caf89-d4ec-41f2-bfc2-e4cfcf51d590",
"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-02-21T09:57:28.9441318+00:00"
},
"modified_dateutc": "2026-02-21T09:57:28.9441318+00:00"
},
"equipment_family_id": "dc78bb21-95cf-4fcd-805a-cd2863cf919c",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "6db9275d-f4fc-45b0-8a81-52cc3182832a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f2c5d7f5-9227-49cc-98a8-20525a7c2e85",
"_parent_code": "sample string 6",
"sales_organization_id": "5ac7c776-cefc-4899-94fb-c140768a95ba",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d75c859c-1ebe-4380-a19a-89e26ba3a4d5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3fc6c446-d172-43bd-bd06-887a527db920",
"db_currency_id": "f0fe69cb-aed0-41be-b694-2bc550e6a516",
"db_language_id": "238caf89-d4ec-41f2-bfc2-e4cfcf51d590",
"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-02-21T09:57:28.9441318+00:00"
},
"modified_dateutc": "2026-02-21T09:57:28.9441318+00:00"
},
"date_in_production_since": "2026-02-21T09:57:28.9441318+00:00",
"date_out_of_production_since": "2026-02-21T09:57:28.9441318+00:00",
"date_end_support": "2026-02-21T09:57:28.9441318+00:00",
"sales_organization_id": "49103557-32a1-4d11-8ade-92b2cd1b92d7",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "d75c859c-1ebe-4380-a19a-89e26ba3a4d5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3fc6c446-d172-43bd-bd06-887a527db920",
"db_currency_id": "f0fe69cb-aed0-41be-b694-2bc550e6a516",
"db_language_id": "238caf89-d4ec-41f2-bfc2-e4cfcf51d590",
"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-02-21T09:57:28.9441318+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-02-21T09:57:28.9441318+00:00"
},
"project_status_id": "a0d03e0f-4938-4a97-8167-1c10976efbe4",
"project_status_code": "sample string 10",
"project_status": {
"id": "812f5cbb-cf9d-458e-bf2d-cbd3a245e2eb",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "ed2d7d6d-ba2b-4847-9996-1e8b47eb4792",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d75c859c-1ebe-4380-a19a-89e26ba3a4d5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3fc6c446-d172-43bd-bd06-887a527db920",
"db_currency_id": "f0fe69cb-aed0-41be-b694-2bc550e6a516",
"db_language_id": "238caf89-d4ec-41f2-bfc2-e4cfcf51d590",
"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-02-21T09:57:28.9441318+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-21T09:57:28.9441318+00:00"
},
"company_id": "557581ca-e814-4e16-acbd-e54f3e157463",
"company_code": "sample string 12",
"db_address_id": "d84763bd-65bf-4a15-b6ae-33be79fbd719",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "1cc24809-41c1-476f-a33e-6f4572dc5716",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "21b41335-adfb-4ca2-a61f-39df475cf370",
"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-02-21T09:57:28.9597556+00:00",
"date_create": "2026-02-21T09:57:28.9597556+00:00",
"date_update": "2026-02-21T09:57:28.9597556+00:00",
"updated_by_user_id": "df759fcf-d024-4cd1-8174-10c8e92f000b",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-02-21T09:57:28.9597556+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-02-21T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-02-21T09:57:28.9597556+00:00",
"date_last_job": "2026-02-21T09:57:28.9597556+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-02-21T09:57:28.9597556+00:00",
"modified_dateutc": "2026-02-21T09:57:28.9597556+00:00",
"is_mobile_installation": true
},
"job_type_id": "7bd97552-86a4-42bf-9abd-4cd13d450e9c",
"job_type_code": "sample string 7",
"job_type": {
"id": "c07a342b-f9ff-48f7-860f-861898b5a277",
"name": "sample string 2",
"sales_organization_id": "6127add8-59d5-4eb9-b3a9-115f2dfb2f8d",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-02-21T09:57:28.9597556+00:00",
"code": "sample string 7"
},
"job_priority_id": "2c086a3b-88f5-4132-a27a-9a24c9cbba68",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "4f798f73-d70d-4fac-839f-7f46b03b8fe6",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "0ad942d1-fb90-42c5-a19f-dea30c923268",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d75c859c-1ebe-4380-a19a-89e26ba3a4d5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3fc6c446-d172-43bd-bd06-887a527db920",
"db_currency_id": "f0fe69cb-aed0-41be-b694-2bc550e6a516",
"db_language_id": "238caf89-d4ec-41f2-bfc2-e4cfcf51d590",
"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-02-21T09:57:28.9441318+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-21T09:57:28.9597556+00:00"
},
"job_status_id": "7e4c120d-11ab-47d1-9312-b13fb0cef1aa",
"job_status_code": "sample string 11",
"db_address_id": "c664a291-bf63-467c-ae8d-8804765de35f",
"contact_id": "6076fc0f-b861-4b97-b73f-7d23645566c4",
"requested_by_company_id": "682f1e11-dd59-47be-a9e6-4e111f9afd7a",
"requested_by_contact_id": "20934f05-2f56-4016-a404-38cfe833f3ef",
"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-02-21T09:57:28.9597556+00:00",
"due_date": "2026-02-21T09:57:28.9597556+00:00",
"date_create": "2026-02-21T09:57:28.9597556+00:00",
"date_update": "2026-02-21T09:57:28.9597556+00:00",
"date_closed": "2026-02-21T09:57:28.9597556+00:00",
"suggested_user_id": "472684f7-2c65-4c96-b040-d6cddc75e358",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "d2a9e58c-6f98-4bc0-bd6c-408eaebb4bcd",
"db_language_id": "fc9afa77-92fa-4d8b-8c22-b58e31096f2a",
"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-02-21T09:57:28.9597556+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "bf9f4f1c-b938-48db-bd60-0529fe7d57f9",
"sales_organization": {
"id": "d75c859c-1ebe-4380-a19a-89e26ba3a4d5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3fc6c446-d172-43bd-bd06-887a527db920",
"db_currency_id": "f0fe69cb-aed0-41be-b694-2bc550e6a516",
"db_language_id": "238caf89-d4ec-41f2-bfc2-e4cfcf51d590",
"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-02-21T09:57:28.9441318+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "429445ce-5f92-4ed2-906a-672ef3f036d7",
"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": "a67c12e8-3f01-4690-909e-fd63b94eb646",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-02-21T09:57:28.9597556+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "d2cc83f8-94bd-44c6-928f-b6fa6b8f7e8f"
},
"suggested_date_start": "2026-02-21T09:57:28.9597556+00:00",
"skill_id": "36d3d550-3ffe-4d35-bc5c-11403af10c57",
"skill_code": "sample string 32",
"skill": {
"id": "74ed6757-da71-443f-b33c-873e6a4f666e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "bdc00447-e179-47b2-82c6-1603f976e519",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d75c859c-1ebe-4380-a19a-89e26ba3a4d5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3fc6c446-d172-43bd-bd06-887a527db920",
"db_currency_id": "f0fe69cb-aed0-41be-b694-2bc550e6a516",
"db_language_id": "238caf89-d4ec-41f2-bfc2-e4cfcf51d590",
"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-02-21T09:57:28.9441318+00:00"
},
"modified_dateutc": "2026-02-21T09:57:28.9597556+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "039854e1-8578-42e7-af73-41dcec3a20c5",
"date_reported_by_company": "2026-02-21T09:57:28.9597556+00:00",
"id2": 36,
"company_id": "afa6d8bf-5311-4f41-a24a-4464b847db20",
"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": "57be680f-09f1-4600-af99-a598655b0216",
"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-02-21T09:57:28.9597556+00:00"
},
"work_instruction_details_id": "d9beb684-1be7-4473-8fa1-548753e3b025",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "01105529-5107-433a-8159-8a87b317f971",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "e5a16c38-a72f-4186-b65f-42561d28fe33",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-02-21T09:57:28.9597556+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": "961e8dd2-4acc-4f40-9aee-73ff47977241",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-02-21T09:57:28.9597556+00:00"
}