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": "ba81cc9b-d174-4922-83cb-914c7648a2d4",
"jobs_id": "f2352fac-ee8a-46df-8d05-6b4cf2fefdea",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "25a9df3f-1832-4fb1-a914-60aeefa974da",
"_parent_id": "a9808e84-b3d0-43d8-9717-f030d44a8e10",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "e84e5ff3-310a-4097-bc97-103978a71cb5",
"project_reference_back_office": "sample string 5",
"project": {
"id": "aaf90877-50b7-400b-9f8c-0637e1ad0e19",
"_parent_id": "3d7885f4-d602-4f43-a801-e7e0a05b7a77",
"root_parent_id": "81114332-a88a-4a1d-9bb1-813d7bbf84fc",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "65831c45-3454-47d6-9bc2-da1992cbec89",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "cbfd2880-7a82-4b6c-8dc6-11c33504e590",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "1a3d75c5-7c87-4bfa-a981-dcc30bb97cd1",
"_parent_code": "sample string 6",
"sales_organization_id": "1dd56abb-e3cb-41fd-ac6d-d090080fc32b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ea4b531d-4e5a-40d9-9393-d1781aa074ce",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3d0fd7ea-5c84-4588-b72b-aae5bbedeb85",
"db_currency_id": "4c7b9130-ebb4-4702-ad68-84a944ab1d26",
"db_language_id": "3487e9d0-7f62-423a-8db9-07d5dfa6ade5",
"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-07-13T08:26:40.5511021+00:00"
},
"modified_dateutc": "2026-07-13T08:26:40.5511021+00:00"
},
"equipment_model_id": "b2d0ac08-783e-44f7-8c10-ee1a3d1564c4",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "5f447a6e-12ef-480f-aedd-79b66cbd21d9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "2fd31f2f-7cb8-4da4-acce-04d3014c4238",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "56bac478-d8c2-42a1-84c4-9f964fb1b7fc",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "9e0b693c-c3c4-4dcf-8ee5-ceb26e3cc1b7",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ea4b531d-4e5a-40d9-9393-d1781aa074ce",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3d0fd7ea-5c84-4588-b72b-aae5bbedeb85",
"db_currency_id": "4c7b9130-ebb4-4702-ad68-84a944ab1d26",
"db_language_id": "3487e9d0-7f62-423a-8db9-07d5dfa6ade5",
"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-07-13T08:26:40.5511021+00:00"
},
"modified_dateutc": "2026-07-13T08:26:40.5511021+00:00"
},
"equipment_family_id": "fff5a4c4-1180-4742-89eb-96afb7a6007b",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "cbfd2880-7a82-4b6c-8dc6-11c33504e590",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "1a3d75c5-7c87-4bfa-a981-dcc30bb97cd1",
"_parent_code": "sample string 6",
"sales_organization_id": "1dd56abb-e3cb-41fd-ac6d-d090080fc32b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ea4b531d-4e5a-40d9-9393-d1781aa074ce",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3d0fd7ea-5c84-4588-b72b-aae5bbedeb85",
"db_currency_id": "4c7b9130-ebb4-4702-ad68-84a944ab1d26",
"db_language_id": "3487e9d0-7f62-423a-8db9-07d5dfa6ade5",
"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-07-13T08:26:40.5511021+00:00"
},
"modified_dateutc": "2026-07-13T08:26:40.5511021+00:00"
},
"date_in_production_since": "2026-07-13T08:26:40.5511021+00:00",
"date_out_of_production_since": "2026-07-13T08:26:40.5511021+00:00",
"date_end_support": "2026-07-13T08:26:40.5511021+00:00",
"sales_organization_id": "935d169b-3bd0-43b4-b394-dda1946e04bb",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "ea4b531d-4e5a-40d9-9393-d1781aa074ce",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3d0fd7ea-5c84-4588-b72b-aae5bbedeb85",
"db_currency_id": "4c7b9130-ebb4-4702-ad68-84a944ab1d26",
"db_language_id": "3487e9d0-7f62-423a-8db9-07d5dfa6ade5",
"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-07-13T08:26:40.5511021+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-07-13T08:26:40.5511021+00:00"
},
"project_status_id": "497e054a-a128-4ea1-9e71-f247cc7e8d41",
"project_status_code": "sample string 10",
"project_status": {
"id": "71926f8a-358d-4c6f-81fd-538a93f5b441",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "d9695dde-474f-4336-9da3-4b9b7e083824",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ea4b531d-4e5a-40d9-9393-d1781aa074ce",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3d0fd7ea-5c84-4588-b72b-aae5bbedeb85",
"db_currency_id": "4c7b9130-ebb4-4702-ad68-84a944ab1d26",
"db_language_id": "3487e9d0-7f62-423a-8db9-07d5dfa6ade5",
"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-07-13T08:26:40.5511021+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-13T08:26:40.5511021+00:00"
},
"company_id": "d0c8ca27-3118-4173-a4e7-b9b028a022e6",
"company_code": "sample string 12",
"db_address_id": "428d00c0-8e25-476e-8940-7b0a8b3a69a9",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "d58ec9be-eafd-47d7-a04d-601a971a4309",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "0e7aa568-69fb-401e-a573-74a02d2924a3",
"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-07-13T08:26:40.5511021+00:00",
"date_create": "2026-07-13T08:26:40.5511021+00:00",
"date_update": "2026-07-13T08:26:40.5511021+00:00",
"updated_by_user_id": "d7132dd5-5a38-4916-99ba-2b411ed69a9e",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-13T08:26:40.5511021+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-07-13T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-13T08:26:40.5511021+00:00",
"date_last_job": "2026-07-13T08:26:40.5511021+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-13T08:26:40.5511021+00:00",
"modified_dateutc": "2026-07-13T08:26:40.5511021+00:00",
"is_mobile_installation": true
},
"job_type_id": "09d6ee7a-eaba-4877-b335-3463ecc5afc7",
"job_type_code": "sample string 7",
"job_type": {
"id": "a3f685db-20dc-4c52-b369-0bb748671fdd",
"name": "sample string 2",
"sales_organization_id": "5a9ac3ed-97ef-4d02-b864-7115861a9c2e",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-13T08:26:40.5511021+00:00",
"code": "sample string 7"
},
"job_priority_id": "cc6a6439-d7a9-4df5-8041-1105679f4420",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "59e431c6-2f6b-473a-9583-078ed0ce9e68",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "d3e1ff91-38d5-4ec0-9f72-de63a0db6a39",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ea4b531d-4e5a-40d9-9393-d1781aa074ce",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3d0fd7ea-5c84-4588-b72b-aae5bbedeb85",
"db_currency_id": "4c7b9130-ebb4-4702-ad68-84a944ab1d26",
"db_language_id": "3487e9d0-7f62-423a-8db9-07d5dfa6ade5",
"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-07-13T08:26:40.5511021+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-13T08:26:40.5511021+00:00"
},
"job_status_id": "80009337-da36-4111-a1ed-4b9a3e795942",
"job_status_code": "sample string 11",
"db_address_id": "a024be3c-6dc9-4def-b272-a055bfb6b532",
"contact_id": "1715833b-4b31-487b-ab9e-03dd57938519",
"requested_by_company_id": "ecf686f6-2105-4dfd-ae71-b0c756e4bf49",
"requested_by_contact_id": "b1796cd1-8dc9-49c4-9ef0-b59214f799c9",
"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-07-13T08:26:40.5511021+00:00",
"due_date": "2026-07-13T08:26:40.5511021+00:00",
"date_create": "2026-07-13T08:26:40.5511021+00:00",
"date_update": "2026-07-13T08:26:40.5511021+00:00",
"date_closed": "2026-07-13T08:26:40.5511021+00:00",
"suggested_user_id": "790b1347-ea81-4db7-ac96-a1abb752ef52",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "cc7e0855-1420-4dbf-9ab0-54ca534cc890",
"db_language_id": "0b4335ad-87ec-4bd8-b15b-b68aaade9236",
"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-07-13T08:26:40.5511021+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "8bdec317-730a-46cb-8be0-8e988dd4fcc0",
"sales_organization": {
"id": "ea4b531d-4e5a-40d9-9393-d1781aa074ce",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3d0fd7ea-5c84-4588-b72b-aae5bbedeb85",
"db_currency_id": "4c7b9130-ebb4-4702-ad68-84a944ab1d26",
"db_language_id": "3487e9d0-7f62-423a-8db9-07d5dfa6ade5",
"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-07-13T08:26:40.5511021+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "d7c5994c-91aa-4af1-91e9-72068fe6d1d5",
"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": "4673ebca-0ea9-4a02-9d22-7205165af56b",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-13T08:26:40.5511021+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "c1533880-7485-4474-a5dd-ab429fb6c388"
},
"suggested_date_start": "2026-07-13T08:26:40.5511021+00:00",
"skill_id": "197ac0a4-5462-4657-9a03-2569fb678992",
"skill_code": "sample string 32",
"skill": {
"id": "7960a117-cceb-4d96-a64c-547649bc9708",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "9d37deeb-282a-451c-b860-5097cd5016f8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ea4b531d-4e5a-40d9-9393-d1781aa074ce",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3d0fd7ea-5c84-4588-b72b-aae5bbedeb85",
"db_currency_id": "4c7b9130-ebb4-4702-ad68-84a944ab1d26",
"db_language_id": "3487e9d0-7f62-423a-8db9-07d5dfa6ade5",
"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-07-13T08:26:40.5511021+00:00"
},
"modified_dateutc": "2026-07-13T08:26:40.5511021+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "04dbc2c4-7fd6-48eb-9160-b3ab15f8b789",
"date_reported_by_company": "2026-07-13T08:26:40.5511021+00:00",
"id2": 36,
"company_id": "aa17df92-d3a3-47a6-834b-2bd3c77ce3c7",
"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": "56431d6c-914b-4843-8ee1-426720758987",
"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-07-13T08:26:40.5511021+00:00"
},
"work_instruction_details_id": "78030846-15d4-45bb-9915-d81b43741121",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "7c3066eb-0f66-4d1b-a45c-66b551bea95f",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "bf01c6dd-4f3a-4e89-abbb-d1e2f2ed739c",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-13T08:26:40.5511021+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": "3510d033-1802-43e0-a6ba-ab30408770fd",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-13T08:26:40.5511021+00:00"
}