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": "b6a03bf6-a09b-409a-b7f9-5f98eadd488b",
"jobs_id": "b65e1864-90f8-44b1-bbb4-c1b4366cd539",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "1b3d1413-1891-470b-bb35-347f0c1b7ef0",
"_parent_id": "a8007232-44fd-4fba-ae72-42608dae802e",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "256afe09-f57b-41d4-9796-76533a597746",
"project_reference_back_office": "sample string 5",
"project": {
"id": "29012098-97fc-48cd-a162-f58aedd52701",
"_parent_id": "78d1613c-ea78-4fb0-b779-9ee0daa11f68",
"root_parent_id": "f8e86269-4fb5-4bef-b0ac-c2a24aea1f4d",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "29cfe232-02a0-407d-a6bf-c992fa4ec695",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "beb8d54c-bed0-488b-8004-2f814e59e2e0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "fde26ffe-e6bb-4aa7-a8c3-1dfa9b89e020",
"_parent_code": "sample string 6",
"sales_organization_id": "09123180-3954-4b90-92d7-6a28b55485e2",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4598290f-42e4-407e-9b8c-a161a3415acf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "985c35b7-13b7-47ac-993a-4e7f689dd028",
"db_currency_id": "999674d9-2aef-47f7-98ea-ef6ddee78333",
"db_language_id": "fdd163d5-be35-4a3f-a85b-cf671ba5700a",
"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-01-31T07:54:53.3435912+00:00"
},
"modified_dateutc": "2026-01-31T07:54:53.3435912+00:00"
},
"equipment_model_id": "7502ef05-ba89-4ea2-8b93-cfffdaaafb4f",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "2e967bef-2651-4a43-ae0d-f264a95e0cc7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "9be8bbc2-a32d-4147-a3a9-61ba25841afb",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "21881c51-224f-4b1e-aaa6-40c1838de6ca",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "22065840-1cbc-473c-8d3c-a05bbdcba7c0",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4598290f-42e4-407e-9b8c-a161a3415acf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "985c35b7-13b7-47ac-993a-4e7f689dd028",
"db_currency_id": "999674d9-2aef-47f7-98ea-ef6ddee78333",
"db_language_id": "fdd163d5-be35-4a3f-a85b-cf671ba5700a",
"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-01-31T07:54:53.3435912+00:00"
},
"modified_dateutc": "2026-01-31T07:54:53.3435912+00:00"
},
"equipment_family_id": "c57266ed-9d0e-4ef6-a052-2449c8a70a16",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "beb8d54c-bed0-488b-8004-2f814e59e2e0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "fde26ffe-e6bb-4aa7-a8c3-1dfa9b89e020",
"_parent_code": "sample string 6",
"sales_organization_id": "09123180-3954-4b90-92d7-6a28b55485e2",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4598290f-42e4-407e-9b8c-a161a3415acf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "985c35b7-13b7-47ac-993a-4e7f689dd028",
"db_currency_id": "999674d9-2aef-47f7-98ea-ef6ddee78333",
"db_language_id": "fdd163d5-be35-4a3f-a85b-cf671ba5700a",
"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-01-31T07:54:53.3435912+00:00"
},
"modified_dateutc": "2026-01-31T07:54:53.3435912+00:00"
},
"date_in_production_since": "2026-01-31T07:54:53.3435912+00:00",
"date_out_of_production_since": "2026-01-31T07:54:53.3435912+00:00",
"date_end_support": "2026-01-31T07:54:53.3435912+00:00",
"sales_organization_id": "db0084e5-651e-4ac7-8ff4-e1cb68e6155e",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "4598290f-42e4-407e-9b8c-a161a3415acf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "985c35b7-13b7-47ac-993a-4e7f689dd028",
"db_currency_id": "999674d9-2aef-47f7-98ea-ef6ddee78333",
"db_language_id": "fdd163d5-be35-4a3f-a85b-cf671ba5700a",
"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-01-31T07:54:53.3435912+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-01-31T07:54:53.3435912+00:00"
},
"project_status_id": "22c48de9-1c5a-4e5c-a215-1e39ac4771bb",
"project_status_code": "sample string 10",
"project_status": {
"id": "27e66e6c-127b-46d9-9fd6-36c961d1cf97",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "952eb8fa-b689-4858-b77a-bb4f3443b8c5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4598290f-42e4-407e-9b8c-a161a3415acf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "985c35b7-13b7-47ac-993a-4e7f689dd028",
"db_currency_id": "999674d9-2aef-47f7-98ea-ef6ddee78333",
"db_language_id": "fdd163d5-be35-4a3f-a85b-cf671ba5700a",
"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-01-31T07:54:53.3435912+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-31T07:54:53.3435912+00:00"
},
"company_id": "ee96cd40-7f93-4b98-99d6-08688635f8bd",
"company_code": "sample string 12",
"db_address_id": "89883c01-6983-45a8-900d-42e61ee48053",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "67defd5a-ce7d-4e2b-a72c-e8de3278f954",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "491fca62-669c-4ae5-a094-0c44e1fbb5dd",
"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-01-31T07:54:53.3435912+00:00",
"date_create": "2026-01-31T07:54:53.3435912+00:00",
"date_update": "2026-01-31T07:54:53.3435912+00:00",
"updated_by_user_id": "6266f75f-5d58-439a-b50e-25914c9a5b9d",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-31T07:54:53.3435912+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-01-31T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-31T07:54:53.3435912+00:00",
"date_last_job": "2026-01-31T07:54:53.3435912+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-31T07:54:53.3435912+00:00",
"modified_dateutc": "2026-01-31T07:54:53.3435912+00:00",
"is_mobile_installation": true
},
"job_type_id": "6d64dd42-0ca0-45a8-b02a-cf73b0139031",
"job_type_code": "sample string 7",
"job_type": {
"id": "422bf8d6-c634-45bf-b315-7196ca153d46",
"name": "sample string 2",
"sales_organization_id": "b2c62cff-9ee2-4859-a75f-6fff9e6c171c",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-31T07:54:53.3435912+00:00",
"code": "sample string 7"
},
"job_priority_id": "389a63c6-23f1-4e4d-867f-0632df79b805",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "599d276d-0558-4307-aaec-608b2a548f94",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "8156455a-1339-47a7-bde1-bb26a94964e4",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4598290f-42e4-407e-9b8c-a161a3415acf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "985c35b7-13b7-47ac-993a-4e7f689dd028",
"db_currency_id": "999674d9-2aef-47f7-98ea-ef6ddee78333",
"db_language_id": "fdd163d5-be35-4a3f-a85b-cf671ba5700a",
"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-01-31T07:54:53.3435912+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-31T07:54:53.3435912+00:00"
},
"job_status_id": "9af4768b-1dba-46b8-9ae3-c088fdb557d1",
"job_status_code": "sample string 11",
"db_address_id": "2e2fef44-dd61-49da-b634-f59d7c76163c",
"contact_id": "9d3b5bea-d4ce-4656-8d94-7d255af57dc7",
"requested_by_company_id": "ecc7541a-96a1-4b6a-b840-f53dd92b2c63",
"requested_by_contact_id": "ca0fd2cb-f2b8-49de-80d4-73a26fed20b0",
"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-01-31T07:54:53.3435912+00:00",
"due_date": "2026-01-31T07:54:53.3435912+00:00",
"date_create": "2026-01-31T07:54:53.3435912+00:00",
"date_update": "2026-01-31T07:54:53.3435912+00:00",
"date_closed": "2026-01-31T07:54:53.3435912+00:00",
"suggested_user_id": "793f188d-cb45-40bd-8057-56181804c2a4",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "23879625-3f13-4ef0-b9c8-5790aefd6256",
"db_language_id": "f315866d-2a6b-4db0-90d1-c75f9c760165",
"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-01-31T07:54:53.3435912+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "e2dda601-f16a-4d64-a873-e9f98c30f12f",
"sales_organization": {
"id": "4598290f-42e4-407e-9b8c-a161a3415acf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "985c35b7-13b7-47ac-993a-4e7f689dd028",
"db_currency_id": "999674d9-2aef-47f7-98ea-ef6ddee78333",
"db_language_id": "fdd163d5-be35-4a3f-a85b-cf671ba5700a",
"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-01-31T07:54:53.3435912+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "f1a2c51c-dbe1-4bf4-a3f2-90305b7218db",
"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": "e79b2e9d-fca8-444c-9227-71226dbc3486",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-31T07:54:53.3435912+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "679c21b3-0c1f-46f4-8903-ffe546385021"
},
"suggested_date_start": "2026-01-31T07:54:53.3435912+00:00",
"skill_id": "4379bf18-175b-4479-b591-c7b43dffdfe9",
"skill_code": "sample string 32",
"skill": {
"id": "7b7a29a5-7838-4692-ad93-10fbf145f7b7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "ba0ad9be-7a7e-4901-91e6-97cba68a0709",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4598290f-42e4-407e-9b8c-a161a3415acf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "985c35b7-13b7-47ac-993a-4e7f689dd028",
"db_currency_id": "999674d9-2aef-47f7-98ea-ef6ddee78333",
"db_language_id": "fdd163d5-be35-4a3f-a85b-cf671ba5700a",
"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-01-31T07:54:53.3435912+00:00"
},
"modified_dateutc": "2026-01-31T07:54:53.3435912+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "4d1f2521-1399-4b4b-990a-f6bece7c63f8",
"date_reported_by_company": "2026-01-31T07:54:53.3435912+00:00",
"id2": 36,
"company_id": "97890fc3-c6cb-46d4-b5df-dcef330a1fde",
"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": "bd6f8bf8-a946-42b0-9892-4b7477eaa43d",
"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-01-31T07:54:53.3435912+00:00"
},
"work_instruction_details_id": "17ec4f22-b469-4e26-93d9-2371b7821b73",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "a90319db-f0c9-42fc-93ec-28ff5e2a119f",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "114c28f8-cb2a-453c-b12b-99a81a7a45dd",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-31T07:54:53.3435912+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": "bfe1d9a1-39be-4e7b-a37f-e945ada206a9",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-31T07:54:53.3435912+00:00"
}