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": "3a34d4a7-324e-4260-ba4a-4f1bcb236902",
"jobs_id": "f104226c-ee75-40da-b0ce-9e08ab977e71",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "4d323b69-c04c-424e-99be-b872f034fc20",
"_parent_id": "e6602265-948c-48ef-8e24-29261273cf2e",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "62ec1ff7-a87a-4984-a4d4-bf8fd6373dce",
"project_reference_back_office": "sample string 5",
"project": {
"id": "8b5f0527-e733-4bb6-a209-b56a90fbcedd",
"_parent_id": "2b3a808a-ac5b-4d98-b630-d2ae88e2572f",
"root_parent_id": "53127c44-ab5b-48f5-a0e3-bdd40b44dc6a",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "8995e8aa-b2c8-44c0-a369-fbf444a4b60f",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "a8992233-8832-4769-8140-9a80b2eaa3b7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e52aae2f-7a17-40e3-ab81-612472bb97cc",
"_parent_code": "sample string 6",
"sales_organization_id": "d15de755-9db0-4ce6-9f83-b6dae2c7a358",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d9e177b4-9afd-4bcc-bd1d-db57cea51397",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7b7e0db5-2ac8-4e77-b4ba-bc98fb31c8ff",
"db_currency_id": "972a53bc-7223-4c4d-b0af-c05cfaa64356",
"db_language_id": "3ae8b0c5-99d1-4dad-b23d-90eb26941ca0",
"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-08-10T14:11:06.1447826+00:00"
},
"modified_dateutc": "2025-08-10T14:11:06.1447826+00:00"
},
"equipment_model_id": "84c89f48-bb2c-4730-9b25-e861871c33ce",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "1e214e22-afe9-415b-9718-8ae0fdefa5aa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "a01f715d-c0c0-4cd5-8599-10488d560c7c",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "80697a7b-e3a7-4449-b203-440c60402c43",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "529b3dfe-5be0-44a5-a87b-09213235192b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d9e177b4-9afd-4bcc-bd1d-db57cea51397",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7b7e0db5-2ac8-4e77-b4ba-bc98fb31c8ff",
"db_currency_id": "972a53bc-7223-4c4d-b0af-c05cfaa64356",
"db_language_id": "3ae8b0c5-99d1-4dad-b23d-90eb26941ca0",
"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-08-10T14:11:06.1447826+00:00"
},
"modified_dateutc": "2025-08-10T14:11:06.1603923+00:00"
},
"equipment_family_id": "4f629063-a33e-4aa5-908e-e9d04b6a7458",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "a8992233-8832-4769-8140-9a80b2eaa3b7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e52aae2f-7a17-40e3-ab81-612472bb97cc",
"_parent_code": "sample string 6",
"sales_organization_id": "d15de755-9db0-4ce6-9f83-b6dae2c7a358",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d9e177b4-9afd-4bcc-bd1d-db57cea51397",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7b7e0db5-2ac8-4e77-b4ba-bc98fb31c8ff",
"db_currency_id": "972a53bc-7223-4c4d-b0af-c05cfaa64356",
"db_language_id": "3ae8b0c5-99d1-4dad-b23d-90eb26941ca0",
"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-08-10T14:11:06.1447826+00:00"
},
"modified_dateutc": "2025-08-10T14:11:06.1447826+00:00"
},
"date_in_production_since": "2025-08-10T14:11:06.176017+00:00",
"date_out_of_production_since": "2025-08-10T14:11:06.176017+00:00",
"date_end_support": "2025-08-10T14:11:06.176017+00:00",
"sales_organization_id": "bf074f00-a2d8-4eb4-9bd9-ddc21aca452c",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "d9e177b4-9afd-4bcc-bd1d-db57cea51397",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7b7e0db5-2ac8-4e77-b4ba-bc98fb31c8ff",
"db_currency_id": "972a53bc-7223-4c4d-b0af-c05cfaa64356",
"db_language_id": "3ae8b0c5-99d1-4dad-b23d-90eb26941ca0",
"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-08-10T14:11:06.1447826+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-08-10T14:11:06.176017+00:00"
},
"project_status_id": "78ca11b5-6ae2-4aa5-93ff-4edd6e30529c",
"project_status_code": "sample string 10",
"project_status": {
"id": "2efd1d4a-60b7-48fd-b181-f43650193247",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "1c7f2a34-456b-4e6e-9fd4-f90a9ee4ec63",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d9e177b4-9afd-4bcc-bd1d-db57cea51397",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7b7e0db5-2ac8-4e77-b4ba-bc98fb31c8ff",
"db_currency_id": "972a53bc-7223-4c4d-b0af-c05cfaa64356",
"db_language_id": "3ae8b0c5-99d1-4dad-b23d-90eb26941ca0",
"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-08-10T14:11:06.1447826+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-08-10T14:11:06.176017+00:00"
},
"company_id": "220e4eaf-834b-444b-b42b-e41d729212c8",
"company_code": "sample string 12",
"db_address_id": "9dc9d5c6-419b-45ae-b5b1-76a781763768",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "0e9e0ab8-2e99-4e17-8f94-a784fd067513",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "9d565b22-3523-47c1-98ef-75a7faca750a",
"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-08-10T14:11:06.191642+00:00",
"date_create": "2025-08-10T14:11:06.191642+00:00",
"date_update": "2025-08-10T14:11:06.191642+00:00",
"updated_by_user_id": "33586847-38dd-4667-88fd-3fc0f4ac11ec",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-08-10T14:11:06.191642+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-08-10T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-08-10T14:11:06.191642+00:00",
"date_last_job": "2025-08-10T14:11:06.191642+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-08-10T14:11:06.191642+00:00",
"modified_dateutc": "2025-08-10T14:11:06.191642+00:00",
"is_mobile_installation": true
},
"job_type_id": "8c307c04-74bf-406f-80a9-4a9ceeb26c18",
"job_type_code": "sample string 7",
"job_type": {
"id": "a20a7668-8f6a-42e4-a33a-622b204b54ec",
"name": "sample string 2",
"sales_organization_id": "193a23c8-34a4-40e9-8c44-5a2c790f0295",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-08-10T14:11:06.191642+00:00",
"code": "sample string 7"
},
"job_priority_id": "772620d2-6685-4d7b-b3a8-310e59c6212b",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "0b32d200-c29d-4dd1-9dde-a0757cd0a9c1",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "abf8a72d-1a6d-482d-b87f-fac0f0c1b80a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d9e177b4-9afd-4bcc-bd1d-db57cea51397",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7b7e0db5-2ac8-4e77-b4ba-bc98fb31c8ff",
"db_currency_id": "972a53bc-7223-4c4d-b0af-c05cfaa64356",
"db_language_id": "3ae8b0c5-99d1-4dad-b23d-90eb26941ca0",
"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-08-10T14:11:06.1447826+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-08-10T14:11:06.191642+00:00"
},
"job_status_id": "0b1b148b-7bf0-4a0d-8b87-5de2805b700f",
"job_status_code": "sample string 11",
"db_address_id": "38eef667-f30a-4868-8042-f163b76b7640",
"contact_id": "d1eac8e0-0dbb-44fe-91cc-7095176af38a",
"requested_by_company_id": "26ff47c3-f24c-4251-a68c-cbd90ac6e2c5",
"requested_by_contact_id": "30e0f119-e614-4c12-8614-115279c05282",
"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-08-10T14:11:06.191642+00:00",
"due_date": "2025-08-10T14:11:06.191642+00:00",
"date_create": "2025-08-10T14:11:06.191642+00:00",
"date_update": "2025-08-10T14:11:06.191642+00:00",
"date_closed": "2025-08-10T14:11:06.191642+00:00",
"suggested_user_id": "2f9cc09e-9834-42fe-89df-30577874d8c4",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "2e59c5b2-df23-409a-b0ae-d0457b90a3e9",
"db_language_id": "c078555c-7cd2-4901-ae27-ad45d4fc9eca",
"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-08-10T14:11:06.191642+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "9aa6ca39-4675-4434-a5e9-16626b13c5e5",
"sales_organization": {
"id": "d9e177b4-9afd-4bcc-bd1d-db57cea51397",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7b7e0db5-2ac8-4e77-b4ba-bc98fb31c8ff",
"db_currency_id": "972a53bc-7223-4c4d-b0af-c05cfaa64356",
"db_language_id": "3ae8b0c5-99d1-4dad-b23d-90eb26941ca0",
"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-08-10T14:11:06.1447826+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "3ad297d7-c55e-4bf2-9bf7-da00f6812c3b",
"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": "12a17d94-d3ad-4307-86cc-d3c705577948",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-08-10T14:11:06.191642+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "245161a0-a216-407b-a458-86faf1ef2db4"
},
"suggested_date_start": "2025-08-10T14:11:06.191642+00:00",
"skill_id": "266e4a63-3bfa-4415-b343-f2edbf34c815",
"skill_code": "sample string 32",
"skill": {
"id": "ed7f43d9-8797-4e4d-8f0e-522607ef531d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "65e72d0f-44b3-43b3-9f06-8d57a7e9939b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d9e177b4-9afd-4bcc-bd1d-db57cea51397",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7b7e0db5-2ac8-4e77-b4ba-bc98fb31c8ff",
"db_currency_id": "972a53bc-7223-4c4d-b0af-c05cfaa64356",
"db_language_id": "3ae8b0c5-99d1-4dad-b23d-90eb26941ca0",
"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-08-10T14:11:06.1447826+00:00"
},
"modified_dateutc": "2025-08-10T14:11:06.191642+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "33e83fd4-7500-4390-83ad-c67a8e259bca",
"date_reported_by_company": "2025-08-10T14:11:06.191642+00:00",
"id2": 36,
"company_id": "d51bea11-ad9c-48fd-b2a9-0fa5c24e2c83",
"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": "69658043-a167-47ab-821e-8615e8f1638b",
"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-08-10T14:11:06.191642+00:00"
},
"work_instruction_details_id": "ec279f1c-b0d6-44af-bbfb-a261177fdb68",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "58d1f77e-0444-4e72-87b9-d3e93df2684f",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "bfcd2ce6-edc7-448f-9a10-a9386a317290",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-08-10T14:11:06.191642+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": "348aadf1-e628-42c6-b395-089bfda371d5",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-08-10T14:11:06.191642+00:00"
}