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": "df23f90c-af75-420a-bdc1-36b388673adb",
"jobs_id": "10154b1d-03c1-49ea-94c9-c0dd9c3fac3b",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "635f1294-c937-4a4c-9845-abd8861a37b1",
"_parent_id": "e30c2055-9530-4564-a5ca-b4b39804fb1b",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "65051599-2038-4e38-b02f-dd35294622d0",
"project_reference_back_office": "sample string 5",
"project": {
"id": "bea57314-2c45-4608-8b7f-040807aed42a",
"_parent_id": "d1925ae6-726e-4084-b539-095d599e266c",
"root_parent_id": "960f2f5d-c7d0-45cc-b1de-22e2c8a032ce",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "1e0f6218-3dc1-4406-a45d-ae4a8a131202",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "bad3e0e0-df87-4399-8093-86227f574b02",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a7075dc3-279d-49db-a44a-f556fd563f9d",
"_parent_code": "sample string 6",
"sales_organization_id": "bb5a0e9b-e98f-4fbe-94d7-0aecf5287cae",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "6770161c-12fd-46fd-9bad-449593fb06e9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "96575a0c-155b-44a2-beba-ffdc2d67c39c",
"db_currency_id": "8bd02be8-cda1-4115-93fb-65ccabfcff09",
"db_language_id": "041f6a28-eab8-4b3f-9b9f-8c4e243dd807",
"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-07-19T00:15:28.6913581+00:00"
},
"modified_dateutc": "2025-07-19T00:15:28.6913581+00:00"
},
"equipment_model_id": "86b200f6-4865-4bdf-bb9b-fa86add41d31",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "2ebfcbec-78ec-4c6e-a19e-24b1add2e411",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "547fbb31-1725-4227-b05b-2fa63028f6e2",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "26db2f3d-c28b-4d9e-bf36-bbddcbde4f70",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "d95bb327-f33f-4607-8964-9f886bbc59c8",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6770161c-12fd-46fd-9bad-449593fb06e9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "96575a0c-155b-44a2-beba-ffdc2d67c39c",
"db_currency_id": "8bd02be8-cda1-4115-93fb-65ccabfcff09",
"db_language_id": "041f6a28-eab8-4b3f-9b9f-8c4e243dd807",
"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-07-19T00:15:28.6913581+00:00"
},
"modified_dateutc": "2025-07-19T00:15:28.6913581+00:00"
},
"equipment_family_id": "a22f348b-c4b8-46c8-a6b2-ac5ca0d53d8b",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "bad3e0e0-df87-4399-8093-86227f574b02",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a7075dc3-279d-49db-a44a-f556fd563f9d",
"_parent_code": "sample string 6",
"sales_organization_id": "bb5a0e9b-e98f-4fbe-94d7-0aecf5287cae",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "6770161c-12fd-46fd-9bad-449593fb06e9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "96575a0c-155b-44a2-beba-ffdc2d67c39c",
"db_currency_id": "8bd02be8-cda1-4115-93fb-65ccabfcff09",
"db_language_id": "041f6a28-eab8-4b3f-9b9f-8c4e243dd807",
"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-07-19T00:15:28.6913581+00:00"
},
"modified_dateutc": "2025-07-19T00:15:28.6913581+00:00"
},
"date_in_production_since": "2025-07-19T00:15:28.8007726+00:00",
"date_out_of_production_since": "2025-07-19T00:15:28.8007726+00:00",
"date_end_support": "2025-07-19T00:15:28.8007726+00:00",
"sales_organization_id": "842d9136-ae55-4ed6-8b11-bf9a7228e13b",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "6770161c-12fd-46fd-9bad-449593fb06e9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "96575a0c-155b-44a2-beba-ffdc2d67c39c",
"db_currency_id": "8bd02be8-cda1-4115-93fb-65ccabfcff09",
"db_language_id": "041f6a28-eab8-4b3f-9b9f-8c4e243dd807",
"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-07-19T00:15:28.6913581+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-07-19T00:15:28.8007726+00:00"
},
"project_status_id": "d0b0253c-5ac9-4c75-bc4e-c61122103c79",
"project_status_code": "sample string 10",
"project_status": {
"id": "5be7be10-9cb0-4619-9628-cd0aa1414cbb",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "dce711d3-9d4e-4796-9ecf-cd18a7eca89e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6770161c-12fd-46fd-9bad-449593fb06e9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "96575a0c-155b-44a2-beba-ffdc2d67c39c",
"db_currency_id": "8bd02be8-cda1-4115-93fb-65ccabfcff09",
"db_language_id": "041f6a28-eab8-4b3f-9b9f-8c4e243dd807",
"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-07-19T00:15:28.6913581+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-07-19T00:15:28.8007726+00:00"
},
"company_id": "71cfc317-a5aa-4c7a-9280-6206246ad4b8",
"company_code": "sample string 12",
"db_address_id": "d565c8cf-14b9-4d38-90cf-964547d8e66d",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "2d1902a4-3a94-4b27-b8ca-f300bc685117",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "0a8ca8e1-e071-4cb8-b8a9-1d867af2f3b8",
"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-07-19T00:15:28.8007726+00:00",
"date_create": "2025-07-19T00:15:28.8007726+00:00",
"date_update": "2025-07-19T00:15:28.8007726+00:00",
"updated_by_user_id": "36d9fdcd-d984-46a6-9dd9-5198ca107543",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-07-19T00:15:28.8007726+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-07-19T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-07-19T00:15:28.8007726+00:00",
"date_last_job": "2025-07-19T00:15:28.8007726+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-07-19T00:15:28.8007726+00:00",
"modified_dateutc": "2025-07-19T00:15:28.8007726+00:00",
"is_mobile_installation": true
},
"job_type_id": "88ead6a8-6ff6-48c7-9610-a09f8e182f6a",
"job_type_code": "sample string 7",
"job_type": {
"id": "6e1bad8c-dc46-4082-9634-900120d3f8fe",
"name": "sample string 2",
"sales_organization_id": "d8cc680f-2f3f-4404-ae43-c47137411bd6",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-07-19T00:15:28.8007726+00:00",
"code": "sample string 7"
},
"job_priority_id": "a6d54e5f-8d7a-44b8-b198-ed9e98e77eba",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "d377631a-7b96-43cd-9a7c-ede6ffbba34b",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "6783b22a-50bd-4a4e-b3d6-78f9b5b39a1e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6770161c-12fd-46fd-9bad-449593fb06e9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "96575a0c-155b-44a2-beba-ffdc2d67c39c",
"db_currency_id": "8bd02be8-cda1-4115-93fb-65ccabfcff09",
"db_language_id": "041f6a28-eab8-4b3f-9b9f-8c4e243dd807",
"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-07-19T00:15:28.6913581+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-07-19T00:15:28.8007726+00:00"
},
"job_status_id": "ad0f7e3c-d8f6-49fd-88d3-1025b5b90e79",
"job_status_code": "sample string 11",
"db_address_id": "39d92911-9302-4eaa-9bf0-1ce7bd7397f5",
"contact_id": "c14d8602-82dd-41e9-a9bb-781bf6aa0bac",
"requested_by_company_id": "4fee4c2c-44f2-499e-98dc-579b47b64055",
"requested_by_contact_id": "f18702a8-83cc-44ff-8f2c-53df78213116",
"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-07-19T00:15:28.8007726+00:00",
"due_date": "2025-07-19T00:15:28.8007726+00:00",
"date_create": "2025-07-19T00:15:28.8007726+00:00",
"date_update": "2025-07-19T00:15:28.8007726+00:00",
"date_closed": "2025-07-19T00:15:28.8007726+00:00",
"suggested_user_id": "3f04beea-c5f1-4390-bb4c-1f66398e56cf",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "546fb705-f73d-42f7-b203-27f65207d5fc",
"db_language_id": "c55d3ec2-49aa-4761-9cd1-8ca243eaca3f",
"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-07-19T00:15:28.8007726+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "aaa784d0-1879-4d22-a201-5a79dbc60d90",
"sales_organization": {
"id": "6770161c-12fd-46fd-9bad-449593fb06e9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "96575a0c-155b-44a2-beba-ffdc2d67c39c",
"db_currency_id": "8bd02be8-cda1-4115-93fb-65ccabfcff09",
"db_language_id": "041f6a28-eab8-4b3f-9b9f-8c4e243dd807",
"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-07-19T00:15:28.6913581+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "f75e0729-d479-4aaa-abb1-0266c37a126e",
"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": "298cd7fe-043e-4b3f-bcae-0e535bf64b60",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-07-19T00:15:28.8007726+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "74cff4dc-173e-4814-8f7f-c43a715096d7"
},
"suggested_date_start": "2025-07-19T00:15:28.8007726+00:00",
"skill_id": "a9af14fd-c5a4-4462-b77d-5c602a436a81",
"skill_code": "sample string 32",
"skill": {
"id": "2addda61-0ecd-4f7b-b96e-4a30cdc6c08a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "5c21349f-cf7c-4008-bfd8-e0c9df17f65f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6770161c-12fd-46fd-9bad-449593fb06e9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "96575a0c-155b-44a2-beba-ffdc2d67c39c",
"db_currency_id": "8bd02be8-cda1-4115-93fb-65ccabfcff09",
"db_language_id": "041f6a28-eab8-4b3f-9b9f-8c4e243dd807",
"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-07-19T00:15:28.6913581+00:00"
},
"modified_dateutc": "2025-07-19T00:15:28.8007726+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "874daa19-78cf-4785-bc73-5168bfca719e",
"date_reported_by_company": "2025-07-19T00:15:28.8007726+00:00",
"id2": 36,
"company_id": "0922a63f-322f-471a-a6d9-7f77cf3606f3",
"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": "fcc651cd-6087-4f17-8797-fc54a4a037f9",
"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-07-19T00:15:28.8007726+00:00"
},
"work_instruction_details_id": "549e3f6f-a2be-4474-a32c-12e33f8b120c",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "f9ee7bea-1ded-4cd8-a3bd-6d4632d2f319",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "9ec961b3-612f-4331-a2e2-a1d271e3bfda",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-07-19T00:15:28.8007726+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": "2da52869-288c-4ba9-9251-6fe89620adf4",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-07-19T00:15:28.8007726+00:00"
}