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": "3d2a5c8e-029f-4b62-bee1-c77bb0173308",
"jobs_id": "0af8ebb3-fc59-4d91-8667-40c5d435ac9f",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "928a93a4-6b7b-421d-897b-f657038a2c0b",
"_parent_id": "06018b3b-de65-443e-b8e7-e54043fdb183",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "f85f4159-e73c-4ee2-9b21-63a146526e1b",
"project_reference_back_office": "sample string 5",
"project": {
"id": "398fd86c-7d10-4c5f-a8b1-dc1604e8896c",
"_parent_id": "e067f4fb-01e7-40a0-9f72-ccfbbde226b1",
"root_parent_id": "5bddacd5-e9de-4460-becf-c3672d3a7fbd",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "7ecaf6b3-142b-43db-98bf-7a47294453f4",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "240f6643-c6c7-4040-b31b-f91dba293348",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "49d2f832-fa72-4994-bcb3-8f3c89fad6d8",
"_parent_code": "sample string 6",
"sales_organization_id": "144e82d1-398d-40d2-994b-af5bdd0e3374",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d854fc28-683b-4b88-adf7-260bf8bec026",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3a0d1333-72b9-4174-9a46-aa41fc70829a",
"db_currency_id": "66ef8349-252a-463a-864f-c4b948489ebd",
"db_language_id": "5adcf7a6-14b7-4600-8def-142f64b049a2",
"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-25T19:31:24.9888298+00:00"
},
"modified_dateutc": "2026-02-25T19:31:24.9888298+00:00"
},
"equipment_model_id": "1e1121e6-80c6-4e48-8a6b-8b9bfbeb0d3d",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "0710feca-5885-42ac-af7e-7db388ab13f5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "a83f895e-5306-4af6-a780-62b737207cb7",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "2cd9cb30-5dfe-4272-8b2b-45db6373f3da",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "aadb6a2c-f844-42d0-9c56-7aa02b86f774",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d854fc28-683b-4b88-adf7-260bf8bec026",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3a0d1333-72b9-4174-9a46-aa41fc70829a",
"db_currency_id": "66ef8349-252a-463a-864f-c4b948489ebd",
"db_language_id": "5adcf7a6-14b7-4600-8def-142f64b049a2",
"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-25T19:31:24.9888298+00:00"
},
"modified_dateutc": "2026-02-25T19:31:24.9888298+00:00"
},
"equipment_family_id": "43c47bb1-680a-40ce-aa85-a3c68792a100",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "240f6643-c6c7-4040-b31b-f91dba293348",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "49d2f832-fa72-4994-bcb3-8f3c89fad6d8",
"_parent_code": "sample string 6",
"sales_organization_id": "144e82d1-398d-40d2-994b-af5bdd0e3374",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d854fc28-683b-4b88-adf7-260bf8bec026",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3a0d1333-72b9-4174-9a46-aa41fc70829a",
"db_currency_id": "66ef8349-252a-463a-864f-c4b948489ebd",
"db_language_id": "5adcf7a6-14b7-4600-8def-142f64b049a2",
"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-25T19:31:24.9888298+00:00"
},
"modified_dateutc": "2026-02-25T19:31:24.9888298+00:00"
},
"date_in_production_since": "2026-02-25T19:31:24.9888298+00:00",
"date_out_of_production_since": "2026-02-25T19:31:24.9888298+00:00",
"date_end_support": "2026-02-25T19:31:24.9888298+00:00",
"sales_organization_id": "905fd2df-ba36-4a10-9136-cf8c350e5d6f",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "d854fc28-683b-4b88-adf7-260bf8bec026",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3a0d1333-72b9-4174-9a46-aa41fc70829a",
"db_currency_id": "66ef8349-252a-463a-864f-c4b948489ebd",
"db_language_id": "5adcf7a6-14b7-4600-8def-142f64b049a2",
"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-25T19:31:24.9888298+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-25T19:31:24.9888298+00:00"
},
"project_status_id": "4fe4b5f2-477b-4836-b0d0-0ea0ee31031b",
"project_status_code": "sample string 10",
"project_status": {
"id": "37d19e87-518b-4bdd-8c75-f7d43cdd2dc2",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "8c9d3f21-a1cd-44af-87c6-1677ae8f01d8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d854fc28-683b-4b88-adf7-260bf8bec026",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3a0d1333-72b9-4174-9a46-aa41fc70829a",
"db_currency_id": "66ef8349-252a-463a-864f-c4b948489ebd",
"db_language_id": "5adcf7a6-14b7-4600-8def-142f64b049a2",
"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-25T19:31:24.9888298+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-25T19:31:24.9888298+00:00"
},
"company_id": "80618d40-141c-4fc4-b256-d01d2c4ccded",
"company_code": "sample string 12",
"db_address_id": "e5bfc1c1-52ff-4ea6-9fab-0d468530c2fb",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "646f1822-26fe-4af8-956e-4ea2e895f724",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "127b96b2-16a6-4b37-b300-fd5694cc644f",
"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-25T19:31:24.9888298+00:00",
"date_create": "2026-02-25T19:31:24.9888298+00:00",
"date_update": "2026-02-25T19:31:24.9888298+00:00",
"updated_by_user_id": "29936176-2ecc-4b97-bb0a-152210502789",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-02-25T19:31:24.9888298+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-25T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-02-25T19:31:24.9888298+00:00",
"date_last_job": "2026-02-25T19:31:24.9888298+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-02-25T19:31:24.9888298+00:00",
"modified_dateutc": "2026-02-25T19:31:24.9888298+00:00",
"is_mobile_installation": true
},
"job_type_id": "d1ddc786-4e40-4bf5-91fa-3def5f8ae347",
"job_type_code": "sample string 7",
"job_type": {
"id": "f0717c29-cf87-4697-a2e7-e2433c7eff57",
"name": "sample string 2",
"sales_organization_id": "6b051dd1-6512-4f08-97f1-41347c1fae18",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-02-25T19:31:24.9888298+00:00",
"code": "sample string 7"
},
"job_priority_id": "f4f7d6e6-1308-41b4-8bc8-7b041a6e355b",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "09a4f707-cccf-4767-b876-bfeb11dff794",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "444e96d4-5529-402e-b5e1-2f9b6da69fc3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d854fc28-683b-4b88-adf7-260bf8bec026",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3a0d1333-72b9-4174-9a46-aa41fc70829a",
"db_currency_id": "66ef8349-252a-463a-864f-c4b948489ebd",
"db_language_id": "5adcf7a6-14b7-4600-8def-142f64b049a2",
"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-25T19:31:24.9888298+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-25T19:31:24.9888298+00:00"
},
"job_status_id": "913288ee-073e-4b1a-96b6-088777a3bebd",
"job_status_code": "sample string 11",
"db_address_id": "137e837d-220f-42ca-8bee-324a9c7c7d41",
"contact_id": "2f121094-9485-4272-be81-7df4e9dca2ea",
"requested_by_company_id": "cd1e25f4-c915-4ab3-b376-e4f39a414183",
"requested_by_contact_id": "4ede8555-da61-4b02-bfe4-9faf07cd6958",
"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-25T19:31:24.9888298+00:00",
"due_date": "2026-02-25T19:31:24.9888298+00:00",
"date_create": "2026-02-25T19:31:24.9888298+00:00",
"date_update": "2026-02-25T19:31:24.9888298+00:00",
"date_closed": "2026-02-25T19:31:24.9888298+00:00",
"suggested_user_id": "ef20ace7-1b99-46d1-a221-6a40d6b3b96b",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "2b3b1159-0542-42e9-a3cc-96ce00fea0ff",
"db_language_id": "0f9cd916-4fe2-4f63-b11e-d0471e1ad0b7",
"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-25T19:31:24.9888298+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "0a37e853-72cf-42c2-be84-89f4d58f2bea",
"sales_organization": {
"id": "d854fc28-683b-4b88-adf7-260bf8bec026",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3a0d1333-72b9-4174-9a46-aa41fc70829a",
"db_currency_id": "66ef8349-252a-463a-864f-c4b948489ebd",
"db_language_id": "5adcf7a6-14b7-4600-8def-142f64b049a2",
"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-25T19:31:24.9888298+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "80c9b79d-9af3-473a-8ed2-c1c3f6ee6f0a",
"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": "0e7384d9-fff9-4878-89df-f8975ba69e5a",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-02-25T19:31:24.9888298+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "8dec406d-0243-4830-aba8-77fd9e830015"
},
"suggested_date_start": "2026-02-25T19:31:24.9888298+00:00",
"skill_id": "bf0ad8ff-1448-4c0e-959d-32bdaa897d12",
"skill_code": "sample string 32",
"skill": {
"id": "648ab1df-7f81-4cbe-b98d-66517bf07c5f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "32fb09ba-f4e0-4030-a474-cf5cc47f274b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d854fc28-683b-4b88-adf7-260bf8bec026",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3a0d1333-72b9-4174-9a46-aa41fc70829a",
"db_currency_id": "66ef8349-252a-463a-864f-c4b948489ebd",
"db_language_id": "5adcf7a6-14b7-4600-8def-142f64b049a2",
"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-25T19:31:24.9888298+00:00"
},
"modified_dateutc": "2026-02-25T19:31:24.9888298+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "b3700aa1-f675-4c79-ac2b-16a9ebc0717b",
"date_reported_by_company": "2026-02-25T19:31:24.9888298+00:00",
"id2": 36,
"company_id": "e5b3233f-d9ab-437d-bfd0-87d660077742",
"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": "0572c846-33d3-4463-89dd-73883288e1ff",
"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-25T19:31:24.9888298+00:00"
},
"work_instruction_details_id": "13f29361-bd56-4f8f-9c93-cd8d1d2c559e",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "2d577bf1-8526-49bc-9e27-6a771fd2cd91",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "5c5b2e06-1fc5-4662-8261-7d36ea82adf5",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-02-25T19:31:24.9888298+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": "e8b62e9a-37f2-4a87-b1df-6f6677dcaa53",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-02-25T19:31:24.9888298+00:00"
}