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": "d560c425-5288-413d-a5d3-0dc81be1eabf",
"jobs_id": "430da0bc-3c45-4fb7-9d57-a4a063deb3f4",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "e9ebd6a1-e745-4ab3-b74b-687a7c291169",
"_parent_id": "d354bc09-2642-4000-8118-214c6aee8ac2",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "dbcb02d4-3c87-45fc-a06d-16be200582e3",
"project_reference_back_office": "sample string 5",
"project": {
"id": "ffc762f2-9e9e-4f82-b325-d33f8daa8b9a",
"_parent_id": "01a7df2b-e935-4acc-bcef-3aa62f569f9c",
"root_parent_id": "c371810b-40b7-4514-901d-e1f2ad498f10",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "5213b5fc-d895-497b-acb7-b860802a54fe",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "588a144c-0708-4838-8469-5bc944567bce",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "8159a88c-d964-48f0-b0e2-6fcab86d1481",
"_parent_code": "sample string 6",
"sales_organization_id": "b078450a-6f98-4a97-b9ab-e97feb213947",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d53dd657-679f-4e07-b0bc-550862244d25",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dfacfcae-7be8-470a-be86-9d0797b5c362",
"db_currency_id": "725af2b0-e50f-40ec-a4eb-de7f7a8f0248",
"db_language_id": "94568665-df3e-400b-aeb2-12a6ea9f383e",
"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-09-19T19:18:46.5248774+00:00"
},
"modified_dateutc": "2026-09-19T19:18:46.5248774+00:00"
},
"equipment_model_id": "dd9240d0-739f-41e0-b9db-7fa502568a50",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "be005fb6-e350-4c1a-bcae-beaa949f17ef",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "6cc71783-625b-4bcf-b77c-b4138f96b843",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "1efa0d0e-1367-4d0d-8705-3ffb6e4a45e0",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "359ece31-8714-4cd0-95b3-f3058ba44542",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d53dd657-679f-4e07-b0bc-550862244d25",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dfacfcae-7be8-470a-be86-9d0797b5c362",
"db_currency_id": "725af2b0-e50f-40ec-a4eb-de7f7a8f0248",
"db_language_id": "94568665-df3e-400b-aeb2-12a6ea9f383e",
"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-09-19T19:18:46.5248774+00:00"
},
"modified_dateutc": "2026-09-19T19:18:46.5248774+00:00"
},
"equipment_family_id": "f42012ec-26d6-49da-9053-b46c63f58023",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "588a144c-0708-4838-8469-5bc944567bce",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "8159a88c-d964-48f0-b0e2-6fcab86d1481",
"_parent_code": "sample string 6",
"sales_organization_id": "b078450a-6f98-4a97-b9ab-e97feb213947",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d53dd657-679f-4e07-b0bc-550862244d25",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dfacfcae-7be8-470a-be86-9d0797b5c362",
"db_currency_id": "725af2b0-e50f-40ec-a4eb-de7f7a8f0248",
"db_language_id": "94568665-df3e-400b-aeb2-12a6ea9f383e",
"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-09-19T19:18:46.5248774+00:00"
},
"modified_dateutc": "2026-09-19T19:18:46.5248774+00:00"
},
"date_in_production_since": "2026-09-19T19:18:46.5248774+00:00",
"date_out_of_production_since": "2026-09-19T19:18:46.5248774+00:00",
"date_end_support": "2026-09-19T19:18:46.5248774+00:00",
"sales_organization_id": "2923090f-5bbf-4a74-8a77-4ae5a9e81f5f",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "d53dd657-679f-4e07-b0bc-550862244d25",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dfacfcae-7be8-470a-be86-9d0797b5c362",
"db_currency_id": "725af2b0-e50f-40ec-a4eb-de7f7a8f0248",
"db_language_id": "94568665-df3e-400b-aeb2-12a6ea9f383e",
"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-09-19T19:18:46.5248774+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-09-19T19:18:46.5248774+00:00"
},
"project_status_id": "eef1ce12-6095-4d82-a338-3e88f1f34328",
"project_status_code": "sample string 10",
"project_status": {
"id": "f4c0d999-5f47-413d-a8f6-f8ab4553acde",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "8ab400a0-7a3e-40e7-bbc6-09651c3ca464",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d53dd657-679f-4e07-b0bc-550862244d25",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dfacfcae-7be8-470a-be86-9d0797b5c362",
"db_currency_id": "725af2b0-e50f-40ec-a4eb-de7f7a8f0248",
"db_language_id": "94568665-df3e-400b-aeb2-12a6ea9f383e",
"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-09-19T19:18:46.5248774+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-19T19:18:46.5248774+00:00"
},
"company_id": "73b8b947-3583-440a-ade9-9068b28e5adf",
"company_code": "sample string 12",
"db_address_id": "4c2cfa24-714c-40d9-b670-7c478176bf09",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "741871b0-8440-4ad8-a83d-82ddff148d0a",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "229c3e9b-0294-4719-ab45-626287fc46cd",
"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-09-19T19:18:46.5248774+00:00",
"date_create": "2026-09-19T19:18:46.5248774+00:00",
"date_update": "2026-09-19T19:18:46.5248774+00:00",
"updated_by_user_id": "6077acb7-15aa-4add-84b4-8b66589b0051",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-19T19:18:46.5248774+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-09-19T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-19T19:18:46.5248774+00:00",
"date_last_job": "2026-09-19T19:18:46.5248774+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-19T19:18:46.5248774+00:00",
"modified_dateutc": "2026-09-19T19:18:46.5248774+00:00",
"is_mobile_installation": true
},
"job_type_id": "9fa57295-f4d5-4caa-8386-b8ad07165330",
"job_type_code": "sample string 7",
"job_type": {
"id": "36c28677-2580-4eb1-a91f-c2d9139ba484",
"name": "sample string 2",
"sales_organization_id": "5c7a7949-b2be-4f8e-b85a-dc296cbed80c",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-19T19:18:46.5248774+00:00",
"code": "sample string 7"
},
"job_priority_id": "c4d1a5cf-353e-4475-83e1-264e69545777",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "47978ae4-4598-4052-9e5e-1646f9131519",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "7b34af50-c124-469c-890e-2addfe086ff5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d53dd657-679f-4e07-b0bc-550862244d25",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dfacfcae-7be8-470a-be86-9d0797b5c362",
"db_currency_id": "725af2b0-e50f-40ec-a4eb-de7f7a8f0248",
"db_language_id": "94568665-df3e-400b-aeb2-12a6ea9f383e",
"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-09-19T19:18:46.5248774+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-19T19:18:46.5248774+00:00"
},
"job_status_id": "d3d42581-620a-4aff-9a37-bd307f806eac",
"job_status_code": "sample string 11",
"db_address_id": "bc3156e7-fb36-45c2-a85c-81df2094cbd4",
"contact_id": "0b916f6e-fa44-48a2-ab2f-68675a094a35",
"requested_by_company_id": "82b894c0-ac5f-4471-9325-259921e290b6",
"requested_by_contact_id": "542a0260-76ed-4994-9284-5a2a55dc5b06",
"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-09-19T19:18:46.5248774+00:00",
"due_date": "2026-09-19T19:18:46.5248774+00:00",
"date_create": "2026-09-19T19:18:46.5248774+00:00",
"date_update": "2026-09-19T19:18:46.5248774+00:00",
"date_closed": "2026-09-19T19:18:46.5248774+00:00",
"suggested_user_id": "059e0cd4-49ff-43d3-84dd-729bb1ce470f",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "52012d8b-2632-40c5-a34e-ed60158b1a38",
"db_language_id": "1a6d647d-073f-49bf-9c44-4836b5d6d44e",
"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-09-19T19:18:46.5248774+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "f9b00030-5860-43f4-b26a-5c613e22da48",
"sales_organization": {
"id": "d53dd657-679f-4e07-b0bc-550862244d25",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dfacfcae-7be8-470a-be86-9d0797b5c362",
"db_currency_id": "725af2b0-e50f-40ec-a4eb-de7f7a8f0248",
"db_language_id": "94568665-df3e-400b-aeb2-12a6ea9f383e",
"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-09-19T19:18:46.5248774+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "540ca00f-5333-46c4-a4d6-5f44e52f4464",
"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": "0f5ea91d-51e7-4ac6-a540-00ea6eac5f8c",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-19T19:18:46.5248774+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "41130dc1-b238-4ac9-8835-7be66bf1c9ed"
},
"suggested_date_start": "2026-09-19T19:18:46.5248774+00:00",
"skill_id": "7d137028-ed96-4856-a6d7-640431158f53",
"skill_code": "sample string 32",
"skill": {
"id": "fe50a424-a4d9-41b9-a6d5-49429d7082c8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "dd9bf3a3-5c47-4d26-938b-ed7d78db6fc5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d53dd657-679f-4e07-b0bc-550862244d25",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dfacfcae-7be8-470a-be86-9d0797b5c362",
"db_currency_id": "725af2b0-e50f-40ec-a4eb-de7f7a8f0248",
"db_language_id": "94568665-df3e-400b-aeb2-12a6ea9f383e",
"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-09-19T19:18:46.5248774+00:00"
},
"modified_dateutc": "2026-09-19T19:18:46.5248774+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "b4e5c21a-283a-4984-ad44-70cf01dc1858",
"date_reported_by_company": "2026-09-19T19:18:46.5248774+00:00",
"id2": 36,
"company_id": "a4958c8f-fb4a-401e-bac4-15970cf8f158",
"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": "5024ea8b-d3a6-43e5-a121-c4ee3ef82e2b",
"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-09-19T19:18:46.5248774+00:00"
},
"work_instruction_details_id": "593976f0-dc53-4f2b-a026-be6d61941c97",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "0a7fa8f8-6c9a-4606-b4e2-ff369368e619",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "b27d61be-d35d-468f-96c7-5c92c1a65cc2",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-19T19:18:46.5248774+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": "6b8cb079-ce0c-425c-bb73-60576606e93b",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-19T19:18:46.5248774+00:00"
}