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_listName | 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
{ "id": "ef8c80c7-b061-4205-b703-d0eefb7eabe3", "jobs_id": "7c55d4fc-baf3-4164-9615-c5f72278217e", "jobs_reference_back_office": "sample string 3", "jobs": { "id": "9f3dceca-4683-4193-b7a3-f078f7a7daca", "_parent_id": "ebec75ea-0325-47b8-b31a-e8081c2a689f", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "fd840fa9-a1e2-4e20-a342-4cde452e591b", "project_reference_back_office": "sample string 5", "project": { "id": "c8886290-aa45-47e9-b44c-8eb8ccffc4b8", "_parent_id": "8b35caf2-d5b1-4dd6-96fa-7bd00b99388b", "root_parent_id": "f505717a-05b8-46fa-a1a0-a1c654d91794", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "a9d3ae3d-1042-423d-9d86-004e29060014", "equipment_family_code": "sample string 6", "equipment_family": { "id": "424e17e7-d66d-43b4-9bfb-64f7d9f1f1fe", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "5816372f-4e98-4f9d-8ab4-47362e1de533", "_parent_code": "sample string 6", "sales_organization_id": "134e1ea0-b24a-4b42-bea6-0d78d7330adf", "sales_organization_code": "sample string 8", "sales_organization": { "id": "9abae5d5-119f-470a-9612-5daf67543d7e", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "fed298d3-b216-4ad4-a655-bc38ebdde98c", "db_currency_id": "b7adc314-b79a-4c60-b9b2-e0604402c6bf", "db_language_id": "a80f4cc1-c8c6-4840-a739-fc7b90986e51", "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": "2024-03-26T17:50:53.386105+00:00" }, "modified_dateutc": "2024-03-26T17:50:53.386105+00:00" }, "equipment_model_id": "c444f2d9-6c95-40c2-a027-a82000767c2a", "equipment_model_code": "sample string 8", "equipment_model": { "id": "704a134c-b089-4a7e-9e47-d9a9b2e3fad8", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "10a4449f-5b19-45af-ad5a-2839cc6bd121", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "89df71a2-9ea1-4b40-b09a-bdf8b4402534", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "26d85239-992c-4c95-a217-169354c9e968", "sales_organization_code": "sample string 5", "sales_organization": { "id": "9abae5d5-119f-470a-9612-5daf67543d7e", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "fed298d3-b216-4ad4-a655-bc38ebdde98c", "db_currency_id": "b7adc314-b79a-4c60-b9b2-e0604402c6bf", "db_language_id": "a80f4cc1-c8c6-4840-a739-fc7b90986e51", "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": "2024-03-26T17:50:53.386105+00:00" }, "modified_dateutc": "2024-03-26T17:50:53.386105+00:00" }, "equipment_family_id": "70ce72c7-9b22-4265-97e8-65d888411850", "equipment_family_code": "sample string 8", "equipment_family": { "id": "424e17e7-d66d-43b4-9bfb-64f7d9f1f1fe", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "5816372f-4e98-4f9d-8ab4-47362e1de533", "_parent_code": "sample string 6", "sales_organization_id": "134e1ea0-b24a-4b42-bea6-0d78d7330adf", "sales_organization_code": "sample string 8", "sales_organization": { "id": "9abae5d5-119f-470a-9612-5daf67543d7e", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "fed298d3-b216-4ad4-a655-bc38ebdde98c", "db_currency_id": "b7adc314-b79a-4c60-b9b2-e0604402c6bf", "db_language_id": "a80f4cc1-c8c6-4840-a739-fc7b90986e51", "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": "2024-03-26T17:50:53.386105+00:00" }, "modified_dateutc": "2024-03-26T17:50:53.386105+00:00" }, "date_in_production_since": "2024-03-26T17:50:53.386105+00:00", "date_out_of_production_since": "2024-03-26T17:50:53.386105+00:00", "date_end_support": "2024-03-26T17:50:53.386105+00:00", "sales_organization_id": "c78c94f4-3059-4252-bbe3-283e892f8428", "sales_organization_code": "sample string 13", "sales_organization": { "id": "9abae5d5-119f-470a-9612-5daf67543d7e", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "fed298d3-b216-4ad4-a655-bc38ebdde98c", "db_currency_id": "b7adc314-b79a-4c60-b9b2-e0604402c6bf", "db_language_id": "a80f4cc1-c8c6-4840-a739-fc7b90986e51", "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": "2024-03-26T17:50:53.386105+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": "2024-03-26T17:50:53.386105+00:00" }, "project_status_id": "3da8a12a-f6c8-4473-93cf-1821453a2e89", "project_status_code": "sample string 10", "project_status": { "id": "866c25ed-4c2b-4474-b949-621b2f7cedb1", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "838e4577-c1d6-4df3-b4dd-20a57e68dd73", "sales_organization_code": "sample string 6", "sales_organization": { "id": "9abae5d5-119f-470a-9612-5daf67543d7e", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "fed298d3-b216-4ad4-a655-bc38ebdde98c", "db_currency_id": "b7adc314-b79a-4c60-b9b2-e0604402c6bf", "db_language_id": "a80f4cc1-c8c6-4840-a739-fc7b90986e51", "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": "2024-03-26T17:50:53.386105+00:00" }, "code": "sample string 7", "modified_dateutc": "2024-03-26T17:50:53.386105+00:00" }, "company_id": "e9d6b3fa-1ee2-422f-bb61-4f9a1cea50fd", "company_code": "sample string 12", "db_address_id": "21f83a15-fb8f-42a9-ad1d-9d6e16083ccf", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "d4a0acb7-9fbe-4ea6-99ec-1e115cd9a6b0", "contact_reference_back_office": "sample string 17", "owner_user_id": "a1c652f0-b95f-475a-a69a-01e8efe81727", "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": "2024-03-26T17:50:53.386105+00:00", "date_create": "2024-03-26T17:50:53.386105+00:00", "date_update": "2024-03-26T17:50:53.386105+00:00", "updated_by_user_id": "f8182872-9c32-4350-96d9-4c6aa945ebe9", "customer_reference": "sample string 28", "warranty_date_until": "2024-03-26T17:50:53.386105+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": "2024-03-26T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2024-03-26T17:50:53.386105+00:00", "date_last_job": "2024-03-26T17:50:53.386105+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2024-03-26T17:50:53.386105+00:00", "modified_dateutc": "2024-03-26T17:50:53.386105+00:00", "is_mobile_installation": true }, "job_type_id": "b6853938-d231-4a7a-af02-0183c23ea640", "job_type_code": "sample string 7", "job_type": { "id": "00bf42c2-09c9-4442-86aa-25f3722c2efe", "name": "sample string 2", "sales_organization_id": "a9737cdc-7a67-4b94-99d9-3d896f77ee86", "description": "sample string 4", "is_default": true, "modified_dateutc": "2024-03-26T17:50:53.386105+00:00", "code": "sample string 7" }, "job_priority_id": "fcea89c3-65ff-4a34-b87d-aa66f17f3141", "job_priority_code": "sample string 9", "job_priority": { "id": "74837859-2f24-43c7-a9d6-971c1285a1e3", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "ebc509e4-358a-4538-800b-10114439660a", "sales_organization_code": "sample string 6", "sales_organization": { "id": "9abae5d5-119f-470a-9612-5daf67543d7e", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "fed298d3-b216-4ad4-a655-bc38ebdde98c", "db_currency_id": "b7adc314-b79a-4c60-b9b2-e0604402c6bf", "db_language_id": "a80f4cc1-c8c6-4840-a739-fc7b90986e51", "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": "2024-03-26T17:50:53.386105+00:00" }, "code": "sample string 7", "modified_dateutc": "2024-03-26T17:50:53.386105+00:00" }, "job_status_id": "ca55894f-6542-4216-a626-4737665e84fb", "job_status_code": "sample string 11", "db_address_id": "56cb0456-e598-4253-b703-b2909f3e0e0a", "contact_id": "9dd925a4-509e-4898-bd35-48059559539b", "requested_by_company_id": "4f656066-caf2-40c8-a990-dc2ceb594d09", "requested_by_contact_id": "b703d7d7-37bb-463e-8fe7-f90b98c284f5", "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": "2024-03-26T17:50:53.386105+00:00", "due_date": "2024-03-26T17:50:53.386105+00:00", "date_create": "2024-03-26T17:50:53.386105+00:00", "date_update": "2024-03-26T17:50:53.386105+00:00", "date_closed": "2024-03-26T17:50:53.386105+00:00", "suggested_user_id": "f4066d7b-599b-43e2-9f27-c69751dba9d4", "suggested_user_code": "sample string 29", "suggested_user": { "id": "086ecf30-31a7-4725-be4f-ff40c047dcc0", "db_language_id": "e784ee86-9124-4d8e-9e2b-2d4c926b9d71", "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": "2024-03-26T17:50:53.386105+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "b99a5049-f0e4-4fbe-b956-03673155a6f4", "sales_organization": { "id": "9abae5d5-119f-470a-9612-5daf67543d7e", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "fed298d3-b216-4ad4-a655-bc38ebdde98c", "db_currency_id": "b7adc314-b79a-4c60-b9b2-e0604402c6bf", "db_language_id": "a80f4cc1-c8c6-4840-a739-fc7b90986e51", "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": "2024-03-26T17:50:53.386105+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "857aa5f2-5e1e-462d-a095-12e00e1920ed", "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": "f728b052-a218-4ae0-a9eb-1b3d7dc87fae", "private_db_country_code": "sample string 35", "modified_dateutc": "2024-03-26T17:50:53.386105+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "4b73b971-6fbf-4180-8e99-b8badb30447b" }, "suggested_date_start": "2024-03-26T17:50:53.386105+00:00", "skill_id": "385fdd54-f3c7-4f9d-bf06-78b40901f482", "skill_code": "sample string 32", "skill": { "id": "651c7a6c-52e7-474f-80ea-e14411969d7c", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "e2069380-125a-4dd2-bbb1-09302abb3769", "sales_organization_code": "sample string 6", "sales_organization": { "id": "9abae5d5-119f-470a-9612-5daf67543d7e", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "fed298d3-b216-4ad4-a655-bc38ebdde98c", "db_currency_id": "b7adc314-b79a-4c60-b9b2-e0604402c6bf", "db_language_id": "a80f4cc1-c8c6-4840-a739-fc7b90986e51", "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": "2024-03-26T17:50:53.386105+00:00" }, "modified_dateutc": "2024-03-26T17:50:53.386105+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "daedb081-3f9d-4293-8e3d-df6ccf4122a1", "date_reported_by_company": "2024-03-26T17:50:53.386105+00:00", "id2": 36, "company_id": "a5c97ea4-257f-482c-924d-90439ee69843", "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": "6c7f61e9-5266-4801-9f61-ede741a54ed0", "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": "2024-03-26T17:50:53.4017442+00:00" }, "work_instruction_details_id": "75ae7e1d-fb06-45ae-a9d5-1189dbac8db8", "work_instruction_details_reference_back_office": "sample string 5", "user_id": "f18c2669-e183-4ba7-8d56-76e54a057729", "work_instruction_action_type": "sample string 7", "work_instruction_id": "924aeb31-c8dd-4dc2-97a8-4c467532c10b", "work_instruction_reference_back_office": "sample string 9", "name": "sample string 10", "status": "sample string 11", "date_done": "2024-03-26T17:50:53.4017442+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": "6e3fbd58-4248-4eb8-9226-bfdfc5988205", "db_report_type_name": "sample string 18", "modified_dateutc": "2024-03-26T17:50:53.4017442+00:00" }