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": "11a07f14-0b97-4c6a-b801-0984eb71d2d0",
"jobs_id": "c9c0e2af-ef04-48b6-a16e-a1cd202ae4de",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "eb6a2809-126c-41cf-8e51-20e8661d4af4",
"_parent_id": "bdf5a1d3-9d99-4c3d-af36-9d365f9f5bea",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "10f00542-a4d2-45c2-8114-e8a2968fb765",
"project_reference_back_office": "sample string 5",
"project": {
"id": "222e7ade-42ea-4a7e-b436-df28b5861955",
"_parent_id": "78546ad0-458c-48c8-9854-eed127039eae",
"root_parent_id": "8186d061-a57c-4d8d-87fd-5774eef6b3d9",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "c0fe98c3-c569-4477-b916-67035ae54bdd",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "db91950a-bb85-4e6a-b4d9-ff4c5089aed1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "494142a9-f3cd-40e7-8f4e-dddd227f0dbd",
"_parent_code": "sample string 6",
"sales_organization_id": "7b86a1fe-d374-4415-83fb-13955cfde44d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "497e0075-190d-455e-a296-c6866ed3d2c6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e24a3644-9ce7-467e-8456-c54e2cbe7597",
"db_currency_id": "acfadeae-2345-464b-819b-2170b35f1bb2",
"db_language_id": "64433e56-e731-4d70-b722-7dfd058fe42c",
"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-11-16T04:34:57.6575367+00:00"
},
"modified_dateutc": "2025-11-16T04:34:57.6575367+00:00"
},
"equipment_model_id": "89040ac0-1b21-4ff4-b828-87328d728829",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "0203cd6a-bef5-4246-891e-20d78a2379e5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "c2d2e471-f7aa-4da9-81a6-ab692eb8ab7b",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "e55dbcc1-5b64-436e-ba7d-de257dd90730",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "6ff124e0-04bc-45ba-b6c8-2b4c3c03d8d1",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "497e0075-190d-455e-a296-c6866ed3d2c6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e24a3644-9ce7-467e-8456-c54e2cbe7597",
"db_currency_id": "acfadeae-2345-464b-819b-2170b35f1bb2",
"db_language_id": "64433e56-e731-4d70-b722-7dfd058fe42c",
"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-11-16T04:34:57.6575367+00:00"
},
"modified_dateutc": "2025-11-16T04:34:57.6575367+00:00"
},
"equipment_family_id": "eabb0426-0dca-4d52-b623-c064af60b14f",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "db91950a-bb85-4e6a-b4d9-ff4c5089aed1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "494142a9-f3cd-40e7-8f4e-dddd227f0dbd",
"_parent_code": "sample string 6",
"sales_organization_id": "7b86a1fe-d374-4415-83fb-13955cfde44d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "497e0075-190d-455e-a296-c6866ed3d2c6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e24a3644-9ce7-467e-8456-c54e2cbe7597",
"db_currency_id": "acfadeae-2345-464b-819b-2170b35f1bb2",
"db_language_id": "64433e56-e731-4d70-b722-7dfd058fe42c",
"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-11-16T04:34:57.6575367+00:00"
},
"modified_dateutc": "2025-11-16T04:34:57.6575367+00:00"
},
"date_in_production_since": "2025-11-16T04:34:57.6575367+00:00",
"date_out_of_production_since": "2025-11-16T04:34:57.6575367+00:00",
"date_end_support": "2025-11-16T04:34:57.6575367+00:00",
"sales_organization_id": "e0f486f8-3b22-45f0-8966-7e6c890bfe26",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "497e0075-190d-455e-a296-c6866ed3d2c6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e24a3644-9ce7-467e-8456-c54e2cbe7597",
"db_currency_id": "acfadeae-2345-464b-819b-2170b35f1bb2",
"db_language_id": "64433e56-e731-4d70-b722-7dfd058fe42c",
"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-11-16T04:34:57.6575367+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-11-16T04:34:57.6575367+00:00"
},
"project_status_id": "1a469d17-0e3b-401a-92c5-fa424807054b",
"project_status_code": "sample string 10",
"project_status": {
"id": "38acd292-eb3a-4186-b9f6-8cfb0ec55c4b",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "dab148c9-0b35-4e3a-9561-26eb89508296",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "497e0075-190d-455e-a296-c6866ed3d2c6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e24a3644-9ce7-467e-8456-c54e2cbe7597",
"db_currency_id": "acfadeae-2345-464b-819b-2170b35f1bb2",
"db_language_id": "64433e56-e731-4d70-b722-7dfd058fe42c",
"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-11-16T04:34:57.6575367+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-16T04:34:57.6575367+00:00"
},
"company_id": "1e516a40-6b31-410c-879b-ce15c7426efa",
"company_code": "sample string 12",
"db_address_id": "dc625c42-594f-4a3e-8bbe-1041d8485c2e",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "c83fe30f-f9cf-4399-8361-a6d54ed1226a",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "06792760-97a7-4ad1-ad31-3b1036787434",
"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-11-16T04:34:57.6731767+00:00",
"date_create": "2025-11-16T04:34:57.6731767+00:00",
"date_update": "2025-11-16T04:34:57.6731767+00:00",
"updated_by_user_id": "25b58eea-c105-4bb9-9491-66f745f8c05d",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-16T04:34:57.6731767+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-11-16T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-11-16T04:34:57.6731767+00:00",
"date_last_job": "2025-11-16T04:34:57.6731767+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-16T04:34:57.6731767+00:00",
"modified_dateutc": "2025-11-16T04:34:57.6731767+00:00",
"is_mobile_installation": true
},
"job_type_id": "acfe553f-6446-4535-8e5e-313c71f80f4a",
"job_type_code": "sample string 7",
"job_type": {
"id": "b9d9394b-0c43-4677-a21a-c1b44a5aec50",
"name": "sample string 2",
"sales_organization_id": "a5c287e2-647a-46d7-b03c-cb71a271eb4a",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-16T04:34:57.6731767+00:00",
"code": "sample string 7"
},
"job_priority_id": "1628fc36-38ff-42f2-9629-20ae1e315d49",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "7e929671-3fef-482c-973f-7fcbb79a4cf2",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "b28d3db0-0951-4061-a182-84a40b3b472d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "497e0075-190d-455e-a296-c6866ed3d2c6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e24a3644-9ce7-467e-8456-c54e2cbe7597",
"db_currency_id": "acfadeae-2345-464b-819b-2170b35f1bb2",
"db_language_id": "64433e56-e731-4d70-b722-7dfd058fe42c",
"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-11-16T04:34:57.6575367+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-16T04:34:57.6731767+00:00"
},
"job_status_id": "b3e090e4-ce76-4037-840d-a0f063286e30",
"job_status_code": "sample string 11",
"db_address_id": "40a3fb79-2a95-43de-8516-bc4c7689a444",
"contact_id": "d5da6a46-8454-4a66-b1cc-d796f72384cf",
"requested_by_company_id": "be028f83-e9a8-4c10-a456-00a558b7df8b",
"requested_by_contact_id": "bcf72be5-10a6-426a-a112-f6f75b71c6c1",
"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-11-16T04:34:57.6731767+00:00",
"due_date": "2025-11-16T04:34:57.6731767+00:00",
"date_create": "2025-11-16T04:34:57.6731767+00:00",
"date_update": "2025-11-16T04:34:57.6731767+00:00",
"date_closed": "2025-11-16T04:34:57.6731767+00:00",
"suggested_user_id": "ae0aa3a9-748c-49f8-8783-3eb185be7967",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "ea7e810f-cdaa-4d2a-83a8-019e31b65207",
"db_language_id": "c6e23e52-8321-4208-b72c-ab55a276ff6e",
"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-11-16T04:34:57.6731767+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "c41ce5e6-0d76-487a-a5c0-c36e5a823003",
"sales_organization": {
"id": "497e0075-190d-455e-a296-c6866ed3d2c6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e24a3644-9ce7-467e-8456-c54e2cbe7597",
"db_currency_id": "acfadeae-2345-464b-819b-2170b35f1bb2",
"db_language_id": "64433e56-e731-4d70-b722-7dfd058fe42c",
"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-11-16T04:34:57.6575367+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "6cbe0c3b-0db6-4c82-9e6e-10f863387c24",
"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": "9b2ff7c9-cf68-41f8-b238-83a4e7e0ac06",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-16T04:34:57.6731767+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "be74ae1b-f91a-4a83-b8a1-e8bd70999962"
},
"suggested_date_start": "2025-11-16T04:34:57.6731767+00:00",
"skill_id": "ad4840d6-f57b-46d4-9d1d-dd0ec8ce6416",
"skill_code": "sample string 32",
"skill": {
"id": "28173eab-ec1b-4cf2-94ac-a76ec63f0fa5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "cfa9023c-cd3c-46e6-b145-880837d3f2c8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "497e0075-190d-455e-a296-c6866ed3d2c6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e24a3644-9ce7-467e-8456-c54e2cbe7597",
"db_currency_id": "acfadeae-2345-464b-819b-2170b35f1bb2",
"db_language_id": "64433e56-e731-4d70-b722-7dfd058fe42c",
"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-11-16T04:34:57.6575367+00:00"
},
"modified_dateutc": "2025-11-16T04:34:57.6731767+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "ac59f774-5f96-42e8-b69e-8bdeb73e86c6",
"date_reported_by_company": "2025-11-16T04:34:57.6731767+00:00",
"id2": 36,
"company_id": "876cf9eb-2ea9-43e0-9a27-311f27059e6b",
"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": "0ed3c4a2-02b4-4ed6-bf2c-70904dde423f",
"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-11-16T04:34:57.6731767+00:00"
},
"work_instruction_details_id": "1147ca1f-c5c3-4eb1-b369-541bd9b063a0",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "c1f81cd0-fa69-4504-be45-dcb35fff65c2",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "2ff6339d-4a73-4d1c-b1d3-eacced81e2c8",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-11-16T04:34:57.6731767+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": "de3e56a1-64d0-46be-a46e-160eb1f8c179",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-11-16T04:34:57.6731767+00:00"
}