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": "80a69cda-0720-49bf-a8c7-85efda7ea85f",
"jobs_id": "c60c0cac-176a-4e53-a442-ee742de81b0d",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "44327f20-f884-4ff1-98c0-7a8296374577",
"_parent_id": "98535523-7db8-40dd-869b-773de11be3dd",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "4198fe1b-92ff-4bf4-ba68-726636f86004",
"project_reference_back_office": "sample string 5",
"project": {
"id": "c76b8f42-ee18-47ac-a49b-f939489287bb",
"_parent_id": "5a4cfb63-d51f-4d72-a541-44db7c259b66",
"root_parent_id": "ac1e5824-fca6-4af8-b005-66f9af2552bf",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "d05075f8-2b6c-4e83-9498-318fe9ed27f8",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "71f83b7c-8a32-4e21-8fac-acd3dff1a063",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "83d72706-2cce-45ff-8629-f931770b50f3",
"_parent_code": "sample string 6",
"sales_organization_id": "d59cf8a5-43a4-4136-9bf7-1e965e6a5be5",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "8bd29547-ae7e-42c4-a580-d8bc064d085f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "be1078c5-92bc-449c-995a-97876094ce16",
"db_currency_id": "867832a9-ce7d-4fa1-b6a6-b8a75ca5b107",
"db_language_id": "200b8bd0-debd-442c-98d4-b1fe3cc07f69",
"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-14T12:38:27.6353453+00:00"
},
"modified_dateutc": "2026-07-14T12:38:27.6353453+00:00"
},
"equipment_model_id": "2274c3ff-5f7a-40c6-b127-56683a829123",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "7ffcea3e-6252-4b0a-9f65-d1cef79b5fb3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "68f20bc5-885a-42e0-bb1f-468d8df8c6d7",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "24772b6b-0fc9-43fc-9865-6e25bd76fac2",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "aac4f7e4-c54a-4f3d-8c92-c8b5dcf8123e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8bd29547-ae7e-42c4-a580-d8bc064d085f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "be1078c5-92bc-449c-995a-97876094ce16",
"db_currency_id": "867832a9-ce7d-4fa1-b6a6-b8a75ca5b107",
"db_language_id": "200b8bd0-debd-442c-98d4-b1fe3cc07f69",
"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-14T12:38:27.6353453+00:00"
},
"modified_dateutc": "2026-07-14T12:38:27.6353453+00:00"
},
"equipment_family_id": "a39b3609-ef34-4ff0-b0b5-0e0d7b0fa375",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "71f83b7c-8a32-4e21-8fac-acd3dff1a063",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "83d72706-2cce-45ff-8629-f931770b50f3",
"_parent_code": "sample string 6",
"sales_organization_id": "d59cf8a5-43a4-4136-9bf7-1e965e6a5be5",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "8bd29547-ae7e-42c4-a580-d8bc064d085f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "be1078c5-92bc-449c-995a-97876094ce16",
"db_currency_id": "867832a9-ce7d-4fa1-b6a6-b8a75ca5b107",
"db_language_id": "200b8bd0-debd-442c-98d4-b1fe3cc07f69",
"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-14T12:38:27.6353453+00:00"
},
"modified_dateutc": "2026-07-14T12:38:27.6353453+00:00"
},
"date_in_production_since": "2026-07-14T12:38:27.6353453+00:00",
"date_out_of_production_since": "2026-07-14T12:38:27.6353453+00:00",
"date_end_support": "2026-07-14T12:38:27.6353453+00:00",
"sales_organization_id": "9a7c6866-c2cc-4a66-97c6-38f5e48e38ba",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "8bd29547-ae7e-42c4-a580-d8bc064d085f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "be1078c5-92bc-449c-995a-97876094ce16",
"db_currency_id": "867832a9-ce7d-4fa1-b6a6-b8a75ca5b107",
"db_language_id": "200b8bd0-debd-442c-98d4-b1fe3cc07f69",
"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-14T12:38:27.6353453+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-14T12:38:27.6353453+00:00"
},
"project_status_id": "f7975b44-4913-4b06-8423-f0117cbf99ea",
"project_status_code": "sample string 10",
"project_status": {
"id": "fda5ae78-87bf-482e-ac69-1bd29545ea29",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "49b9436f-844d-4bd8-a85c-9cd6ee24082a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8bd29547-ae7e-42c4-a580-d8bc064d085f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "be1078c5-92bc-449c-995a-97876094ce16",
"db_currency_id": "867832a9-ce7d-4fa1-b6a6-b8a75ca5b107",
"db_language_id": "200b8bd0-debd-442c-98d4-b1fe3cc07f69",
"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-14T12:38:27.6353453+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-14T12:38:27.6353453+00:00"
},
"company_id": "6e3e5dde-9af4-4738-a8ab-70d07a8eca57",
"company_code": "sample string 12",
"db_address_id": "80dffa0b-a9c5-4bd3-b35e-5b17089078ae",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "b06448f9-166d-424b-9b63-55a28a9fcfbf",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "9224e1a2-8561-4aac-9029-f93302c69776",
"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-14T12:38:27.6353453+00:00",
"date_create": "2026-07-14T12:38:27.6353453+00:00",
"date_update": "2026-07-14T12:38:27.6353453+00:00",
"updated_by_user_id": "1b370aa7-4c18-48ab-9d26-3c0bfa41ad18",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-14T12:38:27.6353453+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-14T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-14T12:38:27.6353453+00:00",
"date_last_job": "2026-07-14T12:38:27.6353453+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-14T12:38:27.6353453+00:00",
"modified_dateutc": "2026-07-14T12:38:27.6353453+00:00",
"is_mobile_installation": true
},
"job_type_id": "4e05527c-e1a9-4edc-93c1-439b8a7ee144",
"job_type_code": "sample string 7",
"job_type": {
"id": "04bd399a-16c4-4455-8266-46e8e168e847",
"name": "sample string 2",
"sales_organization_id": "452c0fa1-94d3-49a5-bebd-2cca4aba31be",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-14T12:38:27.6353453+00:00",
"code": "sample string 7"
},
"job_priority_id": "c55fea64-13b2-4132-9705-4098cd5e018a",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "9db4ec3c-0077-44d6-b21e-79410e850a22",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "c9f87192-1316-4d09-8f10-cec3653a3d35",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8bd29547-ae7e-42c4-a580-d8bc064d085f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "be1078c5-92bc-449c-995a-97876094ce16",
"db_currency_id": "867832a9-ce7d-4fa1-b6a6-b8a75ca5b107",
"db_language_id": "200b8bd0-debd-442c-98d4-b1fe3cc07f69",
"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-14T12:38:27.6353453+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-14T12:38:27.6353453+00:00"
},
"job_status_id": "f1e9a221-fdd3-4169-8713-c2d640907bae",
"job_status_code": "sample string 11",
"db_address_id": "646c2c00-ff0d-4ce9-a0be-a8dd4f15162b",
"contact_id": "95c615ac-3c31-4093-a410-66df6005f59c",
"requested_by_company_id": "d6a4f2e6-5afe-4cd5-b32a-fa44d865c967",
"requested_by_contact_id": "dcb3bdf1-b28d-4d7c-88a2-99e28dff71a7",
"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-14T12:38:27.6353453+00:00",
"due_date": "2026-07-14T12:38:27.6353453+00:00",
"date_create": "2026-07-14T12:38:27.6353453+00:00",
"date_update": "2026-07-14T12:38:27.6353453+00:00",
"date_closed": "2026-07-14T12:38:27.6353453+00:00",
"suggested_user_id": "ea2858c5-e6c1-4b9b-92e3-2be71ea6c6d5",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "23d83905-c685-4b5a-9335-184df2e7eb5d",
"db_language_id": "d1110c47-e515-46ff-9fd5-c34a63f9fbc0",
"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-14T12:38:27.6353453+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "5f49d684-ecc4-4b25-a0be-b38e104aa5bb",
"sales_organization": {
"id": "8bd29547-ae7e-42c4-a580-d8bc064d085f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "be1078c5-92bc-449c-995a-97876094ce16",
"db_currency_id": "867832a9-ce7d-4fa1-b6a6-b8a75ca5b107",
"db_language_id": "200b8bd0-debd-442c-98d4-b1fe3cc07f69",
"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-14T12:38:27.6353453+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "7cc49270-f19a-4db2-8a05-4303121d4156",
"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": "85b1ce7a-4c90-4cb4-9b86-bf63f0be487e",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-14T12:38:27.6353453+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "e81e0dee-cdcd-4277-aca0-0abd2fe6a2a1"
},
"suggested_date_start": "2026-07-14T12:38:27.6353453+00:00",
"skill_id": "cda43988-92f4-444c-a458-02a6660dd499",
"skill_code": "sample string 32",
"skill": {
"id": "6bcb15e1-de12-4980-a49a-1b2de5e8fc3f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "eb37afc2-18f3-4c64-84b4-ccaef38a9790",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8bd29547-ae7e-42c4-a580-d8bc064d085f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "be1078c5-92bc-449c-995a-97876094ce16",
"db_currency_id": "867832a9-ce7d-4fa1-b6a6-b8a75ca5b107",
"db_language_id": "200b8bd0-debd-442c-98d4-b1fe3cc07f69",
"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-14T12:38:27.6353453+00:00"
},
"modified_dateutc": "2026-07-14T12:38:27.6353453+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "8797ebbc-2ac0-4968-8c63-b21edb4b9167",
"date_reported_by_company": "2026-07-14T12:38:27.6353453+00:00",
"id2": 36,
"company_id": "43164ccb-eaef-4928-b304-68911c57d11b",
"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": "fbdf12e0-62c0-4981-819e-5493c759d850",
"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-14T12:38:27.6353453+00:00"
},
"work_instruction_details_id": "bc734e4d-b293-48d5-9a07-18b51be2c2c0",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "03986b1c-23d8-48cc-a030-8caf82377b4c",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "640f3069-63b7-44c4-a234-91f49dbafdf8",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-14T12:38:27.6353453+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": "264d61f8-8f08-493a-92d1-62afa9f106e0",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-14T12:38:27.6353453+00:00"
}