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": "9f563d32-370b-4edf-9de3-7288baa9cebe",
"jobs_id": "9d265319-a184-424d-b90f-95d74b195ac4",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "dc3c146c-f3bb-4e67-bcb3-33fc53d2dc82",
"_parent_id": "6ceabf56-c6c8-41c6-9783-8dc6bb1bfd4d",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "6d9ea0ef-7249-4240-905c-224d34a08bb7",
"project_reference_back_office": "sample string 5",
"project": {
"id": "30aec0bf-9d4f-4963-9c9b-ad69fce0fc73",
"_parent_id": "82c2108a-8358-4d29-9434-5a4417226b0d",
"root_parent_id": "c557572d-4a4b-4aaa-a548-f31113ef876a",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "b7e7bac1-cebb-4359-88c0-269f9a366bf9",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "571f53a7-ee96-4243-8d1b-dbea899b57ea",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "3c35d42f-e942-4a25-ada4-3e38c38fd93c",
"_parent_code": "sample string 6",
"sales_organization_id": "4dade5f6-0ffe-4e69-b78b-b128d539e402",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "7267fc8c-589d-42ee-818b-c3d0d5df1cf7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "269a1e15-6cf4-4752-ae7d-fd9015162274",
"db_currency_id": "eca6dd24-deb2-4e73-b5e4-eb2a8d710ce3",
"db_language_id": "c12a1a8a-c3ca-4946-ac26-cf26bff6af4b",
"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": "2025-12-25T05:55:14.831086+00:00"
},
"modified_dateutc": "2025-12-25T05:55:14.831086+00:00"
},
"equipment_model_id": "e901f995-5b14-44a4-9632-6c595350384d",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "e5fd4290-cde2-4172-97bc-fa6be6f3edb1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "28100e7e-5912-4b35-9247-8bc7a661be8a",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "dec7f578-442e-4be2-9cb6-821768f2858a",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "aac6227c-cd6f-4453-8615-e33e304deb6b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "7267fc8c-589d-42ee-818b-c3d0d5df1cf7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "269a1e15-6cf4-4752-ae7d-fd9015162274",
"db_currency_id": "eca6dd24-deb2-4e73-b5e4-eb2a8d710ce3",
"db_language_id": "c12a1a8a-c3ca-4946-ac26-cf26bff6af4b",
"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": "2025-12-25T05:55:14.831086+00:00"
},
"modified_dateutc": "2025-12-25T05:55:14.8467126+00:00"
},
"equipment_family_id": "e6e42dd2-3861-43fd-a159-e21f54e68f3e",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "571f53a7-ee96-4243-8d1b-dbea899b57ea",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "3c35d42f-e942-4a25-ada4-3e38c38fd93c",
"_parent_code": "sample string 6",
"sales_organization_id": "4dade5f6-0ffe-4e69-b78b-b128d539e402",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "7267fc8c-589d-42ee-818b-c3d0d5df1cf7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "269a1e15-6cf4-4752-ae7d-fd9015162274",
"db_currency_id": "eca6dd24-deb2-4e73-b5e4-eb2a8d710ce3",
"db_language_id": "c12a1a8a-c3ca-4946-ac26-cf26bff6af4b",
"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": "2025-12-25T05:55:14.831086+00:00"
},
"modified_dateutc": "2025-12-25T05:55:14.831086+00:00"
},
"date_in_production_since": "2025-12-25T05:55:14.8467126+00:00",
"date_out_of_production_since": "2025-12-25T05:55:14.8467126+00:00",
"date_end_support": "2025-12-25T05:55:14.8467126+00:00",
"sales_organization_id": "f87b7867-89bb-4013-a81e-01da6bf1be77",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "7267fc8c-589d-42ee-818b-c3d0d5df1cf7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "269a1e15-6cf4-4752-ae7d-fd9015162274",
"db_currency_id": "eca6dd24-deb2-4e73-b5e4-eb2a8d710ce3",
"db_language_id": "c12a1a8a-c3ca-4946-ac26-cf26bff6af4b",
"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": "2025-12-25T05:55:14.831086+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": "2025-12-25T05:55:14.8467126+00:00"
},
"project_status_id": "13c506a1-5762-43bc-8489-7a0119f46e35",
"project_status_code": "sample string 10",
"project_status": {
"id": "3c77e756-3e5f-4359-a400-7dd125cd7f97",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "79c1204a-5dd1-4f2a-b9c6-9ed492ffee55",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7267fc8c-589d-42ee-818b-c3d0d5df1cf7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "269a1e15-6cf4-4752-ae7d-fd9015162274",
"db_currency_id": "eca6dd24-deb2-4e73-b5e4-eb2a8d710ce3",
"db_language_id": "c12a1a8a-c3ca-4946-ac26-cf26bff6af4b",
"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": "2025-12-25T05:55:14.831086+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-25T05:55:14.8467126+00:00"
},
"company_id": "4e529178-176b-489d-a4fa-df860d3829ac",
"company_code": "sample string 12",
"db_address_id": "e601ad37-33c9-4f36-bed5-d687a91a5f1c",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "fba221c2-b9f7-476c-91de-899adbeb1d2a",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "36a734b2-fd8c-45e3-95bc-f0b4e8cd1a1b",
"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": "2025-12-25T05:55:14.8467126+00:00",
"date_create": "2025-12-25T05:55:14.8467126+00:00",
"date_update": "2025-12-25T05:55:14.8467126+00:00",
"updated_by_user_id": "ea4d3c99-7412-4e99-9d87-152afaf65886",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-25T05:55:14.8467126+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": "2025-12-25T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-25T05:55:14.8467126+00:00",
"date_last_job": "2025-12-25T05:55:14.8467126+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-25T05:55:14.8467126+00:00",
"modified_dateutc": "2025-12-25T05:55:14.8467126+00:00",
"is_mobile_installation": true
},
"job_type_id": "8c178ad4-51ae-4af5-877d-2c20483a45ae",
"job_type_code": "sample string 7",
"job_type": {
"id": "a45c277b-c8b7-47d5-9b8d-ae7fbac0073c",
"name": "sample string 2",
"sales_organization_id": "3887dce1-1a31-4507-aa44-48c6e3efb07b",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-25T05:55:14.8467126+00:00",
"code": "sample string 7"
},
"job_priority_id": "a51449b6-1682-4b33-8c76-788234267509",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "013cefb8-4580-482b-b5ac-9fd65d35446e",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "faf00bee-32d1-4785-89ad-f8924ffc07ed",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7267fc8c-589d-42ee-818b-c3d0d5df1cf7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "269a1e15-6cf4-4752-ae7d-fd9015162274",
"db_currency_id": "eca6dd24-deb2-4e73-b5e4-eb2a8d710ce3",
"db_language_id": "c12a1a8a-c3ca-4946-ac26-cf26bff6af4b",
"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": "2025-12-25T05:55:14.831086+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-25T05:55:14.8467126+00:00"
},
"job_status_id": "8acce742-58ac-42db-bdc5-9ec2df91a12c",
"job_status_code": "sample string 11",
"db_address_id": "37cafe50-a27a-40cc-a85e-02ba5cfe1f78",
"contact_id": "e6b165a4-3b1d-4b5b-abd0-3485f67c535e",
"requested_by_company_id": "a064462f-97f0-48d9-ad02-ee95ca7173f0",
"requested_by_contact_id": "e87ccf77-417f-4b16-a824-87d33c212307",
"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": "2025-12-25T05:55:14.8467126+00:00",
"due_date": "2025-12-25T05:55:14.8467126+00:00",
"date_create": "2025-12-25T05:55:14.8467126+00:00",
"date_update": "2025-12-25T05:55:14.8467126+00:00",
"date_closed": "2025-12-25T05:55:14.8467126+00:00",
"suggested_user_id": "6dadbd1c-89f3-4dc4-b1f2-723bd97a7da8",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "3f5a8bac-3329-49c6-8230-975d1ac9298a",
"db_language_id": "93521ba9-792e-42ef-a690-495200147ce2",
"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": "2025-12-25T05:55:14.8467126+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "63211e25-9324-4f62-b44d-15ce2ebdeec9",
"sales_organization": {
"id": "7267fc8c-589d-42ee-818b-c3d0d5df1cf7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "269a1e15-6cf4-4752-ae7d-fd9015162274",
"db_currency_id": "eca6dd24-deb2-4e73-b5e4-eb2a8d710ce3",
"db_language_id": "c12a1a8a-c3ca-4946-ac26-cf26bff6af4b",
"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": "2025-12-25T05:55:14.831086+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "02eaf720-debb-44d2-bd7b-d711abe6665d",
"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": "675b97ee-65fe-4760-b1c5-44235b3fa869",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-25T05:55:14.8467126+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "533bb17a-3ba6-4cf7-8145-325b1e8c16a9"
},
"suggested_date_start": "2025-12-25T05:55:14.8467126+00:00",
"skill_id": "38c4862c-91f3-4f22-9d05-824689c3d595",
"skill_code": "sample string 32",
"skill": {
"id": "668ba3ca-5a81-4fd8-8403-f336279dd74e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "acf1aca2-28b7-4dbf-8d1d-620159784ba8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7267fc8c-589d-42ee-818b-c3d0d5df1cf7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "269a1e15-6cf4-4752-ae7d-fd9015162274",
"db_currency_id": "eca6dd24-deb2-4e73-b5e4-eb2a8d710ce3",
"db_language_id": "c12a1a8a-c3ca-4946-ac26-cf26bff6af4b",
"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": "2025-12-25T05:55:14.831086+00:00"
},
"modified_dateutc": "2025-12-25T05:55:14.8467126+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "9284ca22-cc6a-4930-8fea-9d4d2b5dc5ca",
"date_reported_by_company": "2025-12-25T05:55:14.8467126+00:00",
"id2": 36,
"company_id": "65dedeb1-70e1-400d-a0cd-2277053a5846",
"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": "a5668c6a-e3e5-4340-a66c-dc637f548987",
"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": "2025-12-25T05:55:14.8623727+00:00"
},
"work_instruction_details_id": "c07299fb-eb11-438f-9927-5a5932e3d6d4",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "30976493-9a1e-4d4b-8507-aa7c79873b6a",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "585c869d-b949-4fd8-bb7b-3608f8d3e69d",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-25T05:55:14.8623727+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": "d534d68e-0cb4-430d-89ac-d32d5186b51f",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-25T05:55:14.8623727+00:00"
}