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": "f34259c3-ef3d-430c-8a9c-b61091d6279f",
"jobs_id": "b04101a8-8274-4300-8a13-6f33435eade8",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "4d139213-3aac-4a64-8918-e7d165c6d2a5",
"_parent_id": "38579c73-6ec9-4a4d-814b-16283fd407c2",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "3f9e47c8-10f7-4e24-9151-a8e975caaf4c",
"project_reference_back_office": "sample string 5",
"project": {
"id": "9c904050-ab91-40db-b8e6-1957843bd1f3",
"_parent_id": "e89daec8-965b-4f39-82ba-3f9fbb039b70",
"root_parent_id": "c86bc6ae-8527-43a5-8b01-55bb215fc1a8",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "3b7bc624-49b6-4e6e-a0d8-7d0731518b2d",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "7c301e59-fb3f-4192-b04e-a17a777d6c13",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7768e828-832c-4479-b2cc-f9d9e2089cf2",
"_parent_code": "sample string 6",
"sales_organization_id": "1c7bfc03-fbea-4b5a-a47a-7ac7cf3565a8",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a117ea17-b36f-4302-bd10-3856f5240397",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4101aba5-7a2d-4fc2-96c6-3923af3cef9b",
"db_currency_id": "aa401a59-d646-4598-b208-29f47e19ad35",
"db_language_id": "35cb877f-7211-4d72-ab32-2a271625b88e",
"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-05-02T03:31:46.964101+00:00"
},
"modified_dateutc": "2026-05-02T03:31:46.964101+00:00"
},
"equipment_model_id": "3a301cbe-ad22-4d0a-865f-32e708b7a6de",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "551c586b-2970-4ad8-b46d-74b260fe8864",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "91c40a67-3d31-4419-9be2-393ac410e3a9",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "1a126b62-68f7-47cd-af70-8f4587d646ae",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "b171178b-6c2f-4e14-87e7-67a021987eec",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a117ea17-b36f-4302-bd10-3856f5240397",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4101aba5-7a2d-4fc2-96c6-3923af3cef9b",
"db_currency_id": "aa401a59-d646-4598-b208-29f47e19ad35",
"db_language_id": "35cb877f-7211-4d72-ab32-2a271625b88e",
"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-05-02T03:31:46.964101+00:00"
},
"modified_dateutc": "2026-05-02T03:31:46.964101+00:00"
},
"equipment_family_id": "8c76d899-ad30-4f89-8779-bd2cff567bce",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "7c301e59-fb3f-4192-b04e-a17a777d6c13",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7768e828-832c-4479-b2cc-f9d9e2089cf2",
"_parent_code": "sample string 6",
"sales_organization_id": "1c7bfc03-fbea-4b5a-a47a-7ac7cf3565a8",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a117ea17-b36f-4302-bd10-3856f5240397",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4101aba5-7a2d-4fc2-96c6-3923af3cef9b",
"db_currency_id": "aa401a59-d646-4598-b208-29f47e19ad35",
"db_language_id": "35cb877f-7211-4d72-ab32-2a271625b88e",
"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-05-02T03:31:46.964101+00:00"
},
"modified_dateutc": "2026-05-02T03:31:46.964101+00:00"
},
"date_in_production_since": "2026-05-02T03:31:46.964101+00:00",
"date_out_of_production_since": "2026-05-02T03:31:46.964101+00:00",
"date_end_support": "2026-05-02T03:31:46.964101+00:00",
"sales_organization_id": "3a2418bf-8ee2-452e-aa7d-c0fe75f7af26",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "a117ea17-b36f-4302-bd10-3856f5240397",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4101aba5-7a2d-4fc2-96c6-3923af3cef9b",
"db_currency_id": "aa401a59-d646-4598-b208-29f47e19ad35",
"db_language_id": "35cb877f-7211-4d72-ab32-2a271625b88e",
"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-05-02T03:31:46.964101+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-05-02T03:31:46.964101+00:00"
},
"project_status_id": "10477395-5f8a-4c81-bf19-464bad8f57ae",
"project_status_code": "sample string 10",
"project_status": {
"id": "63447e5f-4383-4d54-b111-dc05873c813e",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "e4897573-806b-4ddb-8296-05ef2b771f0c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a117ea17-b36f-4302-bd10-3856f5240397",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4101aba5-7a2d-4fc2-96c6-3923af3cef9b",
"db_currency_id": "aa401a59-d646-4598-b208-29f47e19ad35",
"db_language_id": "35cb877f-7211-4d72-ab32-2a271625b88e",
"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-05-02T03:31:46.964101+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-02T03:31:46.964101+00:00"
},
"company_id": "7fa391ee-f5ae-4fd3-ba63-cdc102cc4ce9",
"company_code": "sample string 12",
"db_address_id": "e698af71-6ad8-4403-91bc-c7973eb894e8",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "9652a56e-934f-453a-a4b8-9b280924c005",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "8db95dd9-b015-40e1-8c26-45c9e2caebfc",
"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-05-02T03:31:46.979725+00:00",
"date_create": "2026-05-02T03:31:46.979725+00:00",
"date_update": "2026-05-02T03:31:46.979725+00:00",
"updated_by_user_id": "a80f2acd-268e-4bd0-8cc8-7897c00cc4f5",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-02T03:31:46.979725+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-05-02T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-02T03:31:46.979725+00:00",
"date_last_job": "2026-05-02T03:31:46.979725+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-02T03:31:46.979725+00:00",
"modified_dateutc": "2026-05-02T03:31:46.979725+00:00",
"is_mobile_installation": true
},
"job_type_id": "5e6d9338-85f6-4e3e-9603-00e27f95ca1f",
"job_type_code": "sample string 7",
"job_type": {
"id": "91d08baa-d28d-4421-b625-74dfd84cd44a",
"name": "sample string 2",
"sales_organization_id": "fc336371-e548-4ebe-a5a6-327aa144fc51",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-02T03:31:46.979725+00:00",
"code": "sample string 7"
},
"job_priority_id": "9c19bfca-124d-478d-90e9-cea8feeea91f",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "748e4417-61ca-4bdb-978f-35719df770c4",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "84928a7d-e223-4dd5-a1ef-20015c74d95d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a117ea17-b36f-4302-bd10-3856f5240397",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4101aba5-7a2d-4fc2-96c6-3923af3cef9b",
"db_currency_id": "aa401a59-d646-4598-b208-29f47e19ad35",
"db_language_id": "35cb877f-7211-4d72-ab32-2a271625b88e",
"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-05-02T03:31:46.964101+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-02T03:31:46.979725+00:00"
},
"job_status_id": "b5ba9495-3a70-4da9-bd7d-c434e17962c8",
"job_status_code": "sample string 11",
"db_address_id": "26041318-ff80-4f65-92a0-e19a9576ef51",
"contact_id": "6e9c20ad-d0c7-4013-8473-2858313d8cbb",
"requested_by_company_id": "13b76c0b-4c0d-45ec-ac84-bdfbd1a5d2a8",
"requested_by_contact_id": "2a88ed18-1375-4893-bfec-00ff684be43f",
"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-05-02T03:31:46.979725+00:00",
"due_date": "2026-05-02T03:31:46.979725+00:00",
"date_create": "2026-05-02T03:31:46.979725+00:00",
"date_update": "2026-05-02T03:31:46.979725+00:00",
"date_closed": "2026-05-02T03:31:46.979725+00:00",
"suggested_user_id": "80668eb3-de9a-4a0c-9485-9c5255d815fd",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "e596895c-c287-444f-b8c1-938160e34bc4",
"db_language_id": "cf096820-5446-42c0-b90d-cd5c6b75ae45",
"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-05-02T03:31:46.979725+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "11da1b66-8bba-49c7-abd3-756a88daffca",
"sales_organization": {
"id": "a117ea17-b36f-4302-bd10-3856f5240397",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4101aba5-7a2d-4fc2-96c6-3923af3cef9b",
"db_currency_id": "aa401a59-d646-4598-b208-29f47e19ad35",
"db_language_id": "35cb877f-7211-4d72-ab32-2a271625b88e",
"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-05-02T03:31:46.964101+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "5b79d563-02d1-440f-8f51-3791d0a55c8d",
"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": "ac7f4f78-8153-47e7-ab37-e3a63551e8d7",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-02T03:31:46.979725+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "e24a549c-3eef-417b-b3f9-278c2d50a115"
},
"suggested_date_start": "2026-05-02T03:31:46.979725+00:00",
"skill_id": "a698fd1a-55e8-4572-93e3-65b6d63fbe44",
"skill_code": "sample string 32",
"skill": {
"id": "a0e597f9-3c95-495f-a2ea-df7310dfa088",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "75cb6cd7-5992-475b-81da-3331e1eb9c30",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a117ea17-b36f-4302-bd10-3856f5240397",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4101aba5-7a2d-4fc2-96c6-3923af3cef9b",
"db_currency_id": "aa401a59-d646-4598-b208-29f47e19ad35",
"db_language_id": "35cb877f-7211-4d72-ab32-2a271625b88e",
"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-05-02T03:31:46.964101+00:00"
},
"modified_dateutc": "2026-05-02T03:31:46.979725+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "42786b33-6b54-4437-ba8b-7722296ce556",
"date_reported_by_company": "2026-05-02T03:31:46.979725+00:00",
"id2": 36,
"company_id": "9ea8a0ef-05d1-4d6c-8315-dbf38a1de492",
"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": "10708a79-9079-47cb-8b92-ba13daecb320",
"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-05-02T03:31:46.979725+00:00"
},
"work_instruction_details_id": "2006ee0e-6ca4-4740-bad5-10fea5e6d03d",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "8f463e85-be6c-4348-bd87-e832df4a8df0",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "ae49991f-d00d-46ac-bdbf-009def10dd0a",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-02T03:31:46.979725+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": "b05534ce-5ff3-487b-914c-ef368f9d01ae",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-02T03:31:46.979725+00:00"
}