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": "8848ef56-1e04-4fd1-aede-1a7ac5aaab3a",
"jobs_id": "11951b1c-d740-4e86-b1cf-1ec6fab5f930",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "c5b4f29f-8fdb-448b-8d5c-9bfbbb9922f6",
"_parent_id": "e95004d0-ca9f-4fc6-a041-f635d418c3cc",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "92338e9d-34f8-454a-96b1-10e9ec124d67",
"project_reference_back_office": "sample string 5",
"project": {
"id": "0a7e1d67-2307-46cc-8d35-88c0688bfb91",
"_parent_id": "e3192bdb-590d-4039-92eb-690fdf033670",
"root_parent_id": "8f8b4608-3f16-4015-8dc2-7a442565479f",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "8fcbc7be-3e0a-4658-b32e-4ea8dbc6ab32",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "5bca4472-fe00-4987-a574-46b0ac90498a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "aaa725ed-d6ed-494b-8c51-d23b6df14911",
"_parent_code": "sample string 6",
"sales_organization_id": "383c2f87-1903-426f-a41c-0a9d55274fcb",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4c8be073-3931-41bd-93d2-844788cd57ab",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3e1840d8-7b73-4af2-92f8-fc22a4ae84b2",
"db_currency_id": "916b278e-36ce-411f-a25c-ced2fb53693b",
"db_language_id": "a978aed5-6301-469d-b567-add346219d06",
"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-12T06:11:05.7476401+00:00"
},
"modified_dateutc": "2026-03-12T06:11:05.7476401+00:00"
},
"equipment_model_id": "086a6e56-486a-4441-8391-4e03eefb22fc",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "fc934d6d-0106-4b43-ab8f-62f4aa7da791",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "a3823547-92da-44a3-bcf6-b724e751d1ea",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "8301b674-4183-47e0-9b18-c3b25fd2e329",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "9e151a11-ab96-42dd-b8d4-34bbef6e94a2",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4c8be073-3931-41bd-93d2-844788cd57ab",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3e1840d8-7b73-4af2-92f8-fc22a4ae84b2",
"db_currency_id": "916b278e-36ce-411f-a25c-ced2fb53693b",
"db_language_id": "a978aed5-6301-469d-b567-add346219d06",
"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-12T06:11:05.7476401+00:00"
},
"modified_dateutc": "2026-03-12T06:11:05.7476401+00:00"
},
"equipment_family_id": "3f3a0ab5-3647-41ec-917f-1d2b7db161e5",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "5bca4472-fe00-4987-a574-46b0ac90498a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "aaa725ed-d6ed-494b-8c51-d23b6df14911",
"_parent_code": "sample string 6",
"sales_organization_id": "383c2f87-1903-426f-a41c-0a9d55274fcb",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4c8be073-3931-41bd-93d2-844788cd57ab",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3e1840d8-7b73-4af2-92f8-fc22a4ae84b2",
"db_currency_id": "916b278e-36ce-411f-a25c-ced2fb53693b",
"db_language_id": "a978aed5-6301-469d-b567-add346219d06",
"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-12T06:11:05.7476401+00:00"
},
"modified_dateutc": "2026-03-12T06:11:05.7476401+00:00"
},
"date_in_production_since": "2026-03-12T06:11:05.7476401+00:00",
"date_out_of_production_since": "2026-03-12T06:11:05.7476401+00:00",
"date_end_support": "2026-03-12T06:11:05.7476401+00:00",
"sales_organization_id": "2810dadb-88dd-43c1-afd4-054b5d1396de",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "4c8be073-3931-41bd-93d2-844788cd57ab",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3e1840d8-7b73-4af2-92f8-fc22a4ae84b2",
"db_currency_id": "916b278e-36ce-411f-a25c-ced2fb53693b",
"db_language_id": "a978aed5-6301-469d-b567-add346219d06",
"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-12T06:11:05.7476401+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-12T06:11:05.7476401+00:00"
},
"project_status_id": "f7aea782-821e-4af6-afd1-498117c35ff4",
"project_status_code": "sample string 10",
"project_status": {
"id": "190d9102-be7a-43ac-a7bf-40eff0f0229a",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "dd8e5cee-60ec-4203-8d01-8800996fb865",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4c8be073-3931-41bd-93d2-844788cd57ab",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3e1840d8-7b73-4af2-92f8-fc22a4ae84b2",
"db_currency_id": "916b278e-36ce-411f-a25c-ced2fb53693b",
"db_language_id": "a978aed5-6301-469d-b567-add346219d06",
"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-12T06:11:05.7476401+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-12T06:11:05.7476401+00:00"
},
"company_id": "17098ff1-f7c5-45cf-8c60-b0a1f34bade0",
"company_code": "sample string 12",
"db_address_id": "05d700e3-47aa-4e54-8e0d-5017875ae084",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "505a44db-24f9-4e5b-adc9-ce953181f566",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "159dbf90-51fc-48bd-899f-cd5314d36e40",
"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-12T06:11:05.7476401+00:00",
"date_create": "2026-03-12T06:11:05.7476401+00:00",
"date_update": "2026-03-12T06:11:05.7476401+00:00",
"updated_by_user_id": "8f7cf03b-497b-42ef-9ae4-439cf7718f0a",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-03-12T06:11:05.7476401+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-12T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-03-12T06:11:05.7476401+00:00",
"date_last_job": "2026-03-12T06:11:05.7476401+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-03-12T06:11:05.7476401+00:00",
"modified_dateutc": "2026-03-12T06:11:05.7476401+00:00",
"is_mobile_installation": true
},
"job_type_id": "e1707280-8641-4b6f-a733-1aa8ccffcca4",
"job_type_code": "sample string 7",
"job_type": {
"id": "a1e56fff-0fb1-483b-867e-ead550664b07",
"name": "sample string 2",
"sales_organization_id": "b5e9128c-3ffa-4d79-ab60-18806e9c0e9a",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-03-12T06:11:05.7476401+00:00",
"code": "sample string 7"
},
"job_priority_id": "76b1581e-1baa-47c8-9eb1-40fbfc1f4ec3",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "6071a1a5-3507-4b08-b89b-1f2841569dcc",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "38c632d1-545b-4567-845d-a1d3d9584d59",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4c8be073-3931-41bd-93d2-844788cd57ab",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3e1840d8-7b73-4af2-92f8-fc22a4ae84b2",
"db_currency_id": "916b278e-36ce-411f-a25c-ced2fb53693b",
"db_language_id": "a978aed5-6301-469d-b567-add346219d06",
"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-12T06:11:05.7476401+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-12T06:11:05.7476401+00:00"
},
"job_status_id": "6f8d8996-5a3f-4f45-a48e-d61fb7bff1af",
"job_status_code": "sample string 11",
"db_address_id": "2ebc27c8-05be-449a-8b01-09b0ad9e6fcd",
"contact_id": "33cf8a80-81bc-46d1-a9ec-503543bb348f",
"requested_by_company_id": "9383eea7-a134-4248-9743-702db1f68416",
"requested_by_contact_id": "de0e9d0a-a042-4f12-a8ef-c51ef9b3d939",
"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-12T06:11:05.7476401+00:00",
"due_date": "2026-03-12T06:11:05.7476401+00:00",
"date_create": "2026-03-12T06:11:05.7476401+00:00",
"date_update": "2026-03-12T06:11:05.7476401+00:00",
"date_closed": "2026-03-12T06:11:05.7476401+00:00",
"suggested_user_id": "6b03122f-62e4-4c86-9f2c-eea6aa865f07",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "915fd1f3-0817-4f8f-bb19-1486bd30ed85",
"db_language_id": "639a1a6e-3cdd-4011-b5cb-bce6100e8fe1",
"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-12T06:11:05.7476401+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "3ed0cb2b-356b-4d18-9756-cc1669a3fe1a",
"sales_organization": {
"id": "4c8be073-3931-41bd-93d2-844788cd57ab",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3e1840d8-7b73-4af2-92f8-fc22a4ae84b2",
"db_currency_id": "916b278e-36ce-411f-a25c-ced2fb53693b",
"db_language_id": "a978aed5-6301-469d-b567-add346219d06",
"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-12T06:11:05.7476401+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "54898953-ad0e-4ff7-9587-419a813f9aeb",
"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": "5ebee52b-1975-4a95-adee-cf420a8cff67",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-03-12T06:11:05.7476401+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "651917a4-9c4c-4ea6-8105-8de0f9e6804f"
},
"suggested_date_start": "2026-03-12T06:11:05.7476401+00:00",
"skill_id": "b5952f04-69a1-4b00-bc86-ccf92b23a0bf",
"skill_code": "sample string 32",
"skill": {
"id": "85699435-c34c-4d7c-9b26-80e6a554a5d9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "c88f99a8-48dc-4de4-86c3-ff2464c52141",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4c8be073-3931-41bd-93d2-844788cd57ab",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3e1840d8-7b73-4af2-92f8-fc22a4ae84b2",
"db_currency_id": "916b278e-36ce-411f-a25c-ced2fb53693b",
"db_language_id": "a978aed5-6301-469d-b567-add346219d06",
"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-12T06:11:05.7476401+00:00"
},
"modified_dateutc": "2026-03-12T06:11:05.7476401+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "85a8d048-cff8-481c-9470-3b2684a87ad2",
"date_reported_by_company": "2026-03-12T06:11:05.7476401+00:00",
"id2": 36,
"company_id": "e8023422-1339-417a-81fe-1bd03a34256f",
"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": "471917d0-a363-4c8a-8734-fb2fad054cd6",
"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-12T06:11:05.7476401+00:00"
},
"work_instruction_details_id": "e3606180-5cf2-4dfb-bcf7-92451a40f676",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "2487215b-c016-4a28-9258-0cc4bb06e732",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "6259e067-93b1-43fc-a2b9-f7555d524296",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-03-12T06:11:05.7476401+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": "56761356-5ba7-4bed-86a5-a3588c0b79fa",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-03-12T06:11:05.7476401+00:00"
}