Retrieves all the job work instruction list.
Request Information
URI Parameters :
None.
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": "26d608ea-c954-4843-914f-ff03d66f53a8",
"jobs_id": "747779bd-0b15-4a7f-9e4e-7804ea95cff8",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "ffc438ef-ed91-4fc3-8a7e-6c006bd238f8",
"_parent_id": "e4028e2b-66df-4945-9deb-b26104be24af",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "0c281985-d257-4f91-a3d6-73ec561976fe",
"project_reference_back_office": "sample string 5",
"project": {
"id": "67b6794c-57fd-45e2-a447-63e1cdab916a",
"_parent_id": "9455c8ea-a01d-4e4f-a047-af35ddcc5174",
"root_parent_id": "cdc2ff1a-186a-4f57-ab05-56d88a570caf",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "1dce93e2-c64f-4d76-977b-07bf18ba16e8",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "339fe586-e282-402b-94e2-0d32de605a2d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "08e8022c-79c2-444d-b04f-191ac5fbd24b",
"_parent_code": "sample string 6",
"sales_organization_id": "9e0e882e-14bb-423d-9dab-89a69114c313",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f4212acf-a9b5-41d0-ae67-398c909b28fa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9b92274b-7a72-4e52-8f85-975cfacf463e",
"db_currency_id": "27e72b4e-a8d2-49e5-9c62-d8044fe83693",
"db_language_id": "f45077c0-8b61-4d26-ad27-2b74bd15586c",
"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-03-07T13:59:23.116584+00:00"
},
"modified_dateutc": "2026-03-07T13:59:23.116584+00:00"
},
"equipment_model_id": "61173b5a-e115-4b2b-895c-27c6a0a8c1fc",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "41707959-98be-43dc-a692-c31b9e84f6f5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "2e8af98c-4eb4-49d5-8856-68b940bf393b",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "d72f3734-0488-41c3-b977-cfc76033bc5b",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "9b698196-6837-4823-9d8e-f2a9bc67d73a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f4212acf-a9b5-41d0-ae67-398c909b28fa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9b92274b-7a72-4e52-8f85-975cfacf463e",
"db_currency_id": "27e72b4e-a8d2-49e5-9c62-d8044fe83693",
"db_language_id": "f45077c0-8b61-4d26-ad27-2b74bd15586c",
"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-03-07T13:59:23.116584+00:00"
},
"modified_dateutc": "2026-03-07T13:59:23.116584+00:00"
},
"equipment_family_id": "9e931732-e1ae-4536-8f06-54fff90b82e4",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "339fe586-e282-402b-94e2-0d32de605a2d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "08e8022c-79c2-444d-b04f-191ac5fbd24b",
"_parent_code": "sample string 6",
"sales_organization_id": "9e0e882e-14bb-423d-9dab-89a69114c313",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f4212acf-a9b5-41d0-ae67-398c909b28fa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9b92274b-7a72-4e52-8f85-975cfacf463e",
"db_currency_id": "27e72b4e-a8d2-49e5-9c62-d8044fe83693",
"db_language_id": "f45077c0-8b61-4d26-ad27-2b74bd15586c",
"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-03-07T13:59:23.116584+00:00"
},
"modified_dateutc": "2026-03-07T13:59:23.116584+00:00"
},
"date_in_production_since": "2026-03-07T13:59:23.116584+00:00",
"date_out_of_production_since": "2026-03-07T13:59:23.116584+00:00",
"date_end_support": "2026-03-07T13:59:23.116584+00:00",
"sales_organization_id": "efaf0842-1e21-498a-b39c-38826c6d4a87",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "f4212acf-a9b5-41d0-ae67-398c909b28fa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9b92274b-7a72-4e52-8f85-975cfacf463e",
"db_currency_id": "27e72b4e-a8d2-49e5-9c62-d8044fe83693",
"db_language_id": "f45077c0-8b61-4d26-ad27-2b74bd15586c",
"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-03-07T13:59:23.116584+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-03-07T13:59:23.3197139+00:00"
},
"project_status_id": "29a11220-6824-4cfd-9f86-4d4a3a434f05",
"project_status_code": "sample string 10",
"project_status": {
"id": "963e06c0-182c-4f27-84a2-dd754a667beb",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "a980c60b-8c54-49f7-bb12-c5f539d55ea1",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f4212acf-a9b5-41d0-ae67-398c909b28fa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9b92274b-7a72-4e52-8f85-975cfacf463e",
"db_currency_id": "27e72b4e-a8d2-49e5-9c62-d8044fe83693",
"db_language_id": "f45077c0-8b61-4d26-ad27-2b74bd15586c",
"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-03-07T13:59:23.116584+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-07T13:59:23.3197139+00:00"
},
"company_id": "89c03814-c86d-419c-bd2b-7d9c82108dd1",
"company_code": "sample string 12",
"db_address_id": "abe62ead-522a-4259-833b-2ca2713e5817",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "dc4c4001-0517-438e-870c-0db51b1919a5",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "c8d9efed-c3cc-48da-99f4-7fd8a0445160",
"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-03-07T13:59:23.3197139+00:00",
"date_create": "2026-03-07T13:59:23.3197139+00:00",
"date_update": "2026-03-07T13:59:23.3197139+00:00",
"updated_by_user_id": "f599e442-8e03-4da0-9cf1-c49c0feb3d5b",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-03-07T13:59:23.3197139+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-03-07T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-03-07T13:59:23.3197139+00:00",
"date_last_job": "2026-03-07T13:59:23.3197139+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-03-07T13:59:23.3197139+00:00",
"modified_dateutc": "2026-03-07T13:59:23.3197139+00:00",
"is_mobile_installation": true
},
"job_type_id": "4183094d-e8be-4c18-8998-966e22383f54",
"job_type_code": "sample string 7",
"job_type": {
"id": "c621c07d-bec7-4820-b99a-666a2a801301",
"name": "sample string 2",
"sales_organization_id": "e01d18e8-dc83-4530-8e94-e0d8e0b41f99",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-03-07T13:59:23.3197139+00:00",
"code": "sample string 7"
},
"job_priority_id": "3715e144-fe24-410f-9029-25addd281d69",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "4bf0659a-d196-48fd-94b4-4e036f5c4e0f",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "81f40b86-b228-4aa3-b129-db74c1a2f98d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f4212acf-a9b5-41d0-ae67-398c909b28fa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9b92274b-7a72-4e52-8f85-975cfacf463e",
"db_currency_id": "27e72b4e-a8d2-49e5-9c62-d8044fe83693",
"db_language_id": "f45077c0-8b61-4d26-ad27-2b74bd15586c",
"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-03-07T13:59:23.116584+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-07T13:59:23.3197139+00:00"
},
"job_status_id": "d0d1ca72-ca86-461e-ae15-6d65454b56ac",
"job_status_code": "sample string 11",
"db_address_id": "9b887832-4d54-4a08-b77a-40a118274667",
"contact_id": "9a4e2b05-41fb-488d-8382-3ad31ee93520",
"requested_by_company_id": "4c001b0d-0d54-4e04-a2a0-7ab26eb6bbe1",
"requested_by_contact_id": "49920b76-bf74-4441-84a4-54c8c45b104a",
"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-03-07T13:59:23.3197139+00:00",
"due_date": "2026-03-07T13:59:23.3197139+00:00",
"date_create": "2026-03-07T13:59:23.3197139+00:00",
"date_update": "2026-03-07T13:59:23.3197139+00:00",
"date_closed": "2026-03-07T13:59:23.3197139+00:00",
"suggested_user_id": "b6aabaa6-893a-440f-b309-7564ecbfdae7",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "f71fae52-aa35-4f73-9878-7d6e0272ec75",
"db_language_id": "cbd5ac2c-e7d2-4023-8e14-d7771773e2e4",
"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-03-07T13:59:23.3197139+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "0aa95b80-f098-460b-b128-9d032331cc5b",
"sales_organization": {
"id": "f4212acf-a9b5-41d0-ae67-398c909b28fa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9b92274b-7a72-4e52-8f85-975cfacf463e",
"db_currency_id": "27e72b4e-a8d2-49e5-9c62-d8044fe83693",
"db_language_id": "f45077c0-8b61-4d26-ad27-2b74bd15586c",
"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-03-07T13:59:23.116584+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "cb01a9d1-d2ed-4beb-9528-41bb4a1e3665",
"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": "e097dbcc-b238-4210-a35f-97553614efaa",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-03-07T13:59:23.3197139+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "b4e42447-dd62-4c0f-b3d4-0dc3c39933fa"
},
"suggested_date_start": "2026-03-07T13:59:23.3197139+00:00",
"skill_id": "351b9c0a-f9e1-4914-9282-ab7fa9630fcb",
"skill_code": "sample string 32",
"skill": {
"id": "710553c2-2d88-4ced-a170-9888e4c66197",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "1f3c22cc-7ebb-420b-96e1-3f7b553df0e8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f4212acf-a9b5-41d0-ae67-398c909b28fa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9b92274b-7a72-4e52-8f85-975cfacf463e",
"db_currency_id": "27e72b4e-a8d2-49e5-9c62-d8044fe83693",
"db_language_id": "f45077c0-8b61-4d26-ad27-2b74bd15586c",
"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-03-07T13:59:23.116584+00:00"
},
"modified_dateutc": "2026-03-07T13:59:23.3197139+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "081bc7a7-8a9f-4d6f-a9e9-28ce7db42632",
"date_reported_by_company": "2026-03-07T13:59:23.3197139+00:00",
"id2": 36,
"company_id": "970b1730-ee74-4bfe-95ee-c20446cd69a7",
"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": "b15b6371-3614-4e14-8e10-3383adea2990",
"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-03-07T13:59:23.3197139+00:00"
},
"work_instruction_details_id": "557f0874-c95b-458c-878a-b9fcf0080626",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "a2a2032f-1f92-4502-ac59-544011bfda44",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "0fbcd184-e48d-4260-8d56-5067b81ab410",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-03-07T13:59:23.3197139+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": "43df488d-b1cc-43f6-a399-8d70bf3dd9c7",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-03-07T13:59:23.3197139+00:00"
}