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": "31a8d012-119e-4e7c-8361-be0870f1b579",
"jobs_id": "df504a1f-df5e-41bc-a951-174b5b6583d9",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "0bb0b3a3-00f2-4e53-ac3e-7a8e1cf3ca62",
"_parent_id": "df6d4bb3-4898-48b5-b1fb-fdc29f0ae849",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "6454add1-defe-40a4-970f-2897cf97a34d",
"project_reference_back_office": "sample string 5",
"project": {
"id": "65500959-3ef5-4e2c-a3c2-351f4ea5ef42",
"_parent_id": "7a4e5116-619a-438f-b91d-ece898b52d32",
"root_parent_id": "890d089f-93fc-4f51-af46-420b3b9b8797",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "6edeb634-9592-4f7d-9802-e1e2312809b7",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "e22efcaa-47df-4db9-8fc0-0d5c2e2dc72a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d78680ab-af2b-40b1-8632-b634f934d2b7",
"_parent_code": "sample string 6",
"sales_organization_id": "d7c7cedf-2b83-44ea-be75-4c29fa4389e4",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "49fd5fa7-ab42-4d81-aa5c-9c3e45cd21a1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "79e85a91-ca08-46d7-88d2-810079cb8c6b",
"db_currency_id": "7c4385a9-17a3-4bf8-a01e-8e61bf393aa8",
"db_language_id": "7987cb92-151f-4500-ab0b-022a883b424c",
"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-02-21T13:38:37.5683295+00:00"
},
"modified_dateutc": "2026-02-21T13:38:37.5683295+00:00"
},
"equipment_model_id": "4156d455-befa-49b6-b16f-bc350e4e4ed4",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "8798e62f-eb3f-4dcb-aa0f-61c2007275ef",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "5c1b1810-f4cf-448e-81d7-94546b88c406",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "f0a7b563-32f2-471f-977d-fbf54e9c28f8",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "6683daca-eb12-4d0d-b532-7f3b18a73ad0",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "49fd5fa7-ab42-4d81-aa5c-9c3e45cd21a1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "79e85a91-ca08-46d7-88d2-810079cb8c6b",
"db_currency_id": "7c4385a9-17a3-4bf8-a01e-8e61bf393aa8",
"db_language_id": "7987cb92-151f-4500-ab0b-022a883b424c",
"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-02-21T13:38:37.5683295+00:00"
},
"modified_dateutc": "2026-02-21T13:38:37.5683295+00:00"
},
"equipment_family_id": "044ef50b-2a88-4261-9b2f-0afcfcfeda61",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "e22efcaa-47df-4db9-8fc0-0d5c2e2dc72a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d78680ab-af2b-40b1-8632-b634f934d2b7",
"_parent_code": "sample string 6",
"sales_organization_id": "d7c7cedf-2b83-44ea-be75-4c29fa4389e4",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "49fd5fa7-ab42-4d81-aa5c-9c3e45cd21a1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "79e85a91-ca08-46d7-88d2-810079cb8c6b",
"db_currency_id": "7c4385a9-17a3-4bf8-a01e-8e61bf393aa8",
"db_language_id": "7987cb92-151f-4500-ab0b-022a883b424c",
"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-02-21T13:38:37.5683295+00:00"
},
"modified_dateutc": "2026-02-21T13:38:37.5683295+00:00"
},
"date_in_production_since": "2026-02-21T13:38:37.5683295+00:00",
"date_out_of_production_since": "2026-02-21T13:38:37.5683295+00:00",
"date_end_support": "2026-02-21T13:38:37.5683295+00:00",
"sales_organization_id": "4e714c36-f425-44a1-986e-ef93f7f6d7b4",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "49fd5fa7-ab42-4d81-aa5c-9c3e45cd21a1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "79e85a91-ca08-46d7-88d2-810079cb8c6b",
"db_currency_id": "7c4385a9-17a3-4bf8-a01e-8e61bf393aa8",
"db_language_id": "7987cb92-151f-4500-ab0b-022a883b424c",
"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-02-21T13:38:37.5683295+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-02-21T13:38:37.5683295+00:00"
},
"project_status_id": "3558453a-e9d5-439b-8b59-97354365fe01",
"project_status_code": "sample string 10",
"project_status": {
"id": "4165ff58-829b-4c47-82a1-dfc167523f20",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "cbbed8c5-04bb-47e1-8645-16817c687eaa",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "49fd5fa7-ab42-4d81-aa5c-9c3e45cd21a1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "79e85a91-ca08-46d7-88d2-810079cb8c6b",
"db_currency_id": "7c4385a9-17a3-4bf8-a01e-8e61bf393aa8",
"db_language_id": "7987cb92-151f-4500-ab0b-022a883b424c",
"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-02-21T13:38:37.5683295+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-21T13:38:37.5683295+00:00"
},
"company_id": "3e03cadd-1be9-440e-b65e-f3fff2fa383d",
"company_code": "sample string 12",
"db_address_id": "2e1afd68-1319-4d38-b761-1e2158ed55f6",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "1492a296-6d25-47ae-9c07-308e4889e480",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "aca6fbce-c154-4ed5-aea7-a7f904e56adc",
"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-02-21T13:38:37.5683295+00:00",
"date_create": "2026-02-21T13:38:37.5683295+00:00",
"date_update": "2026-02-21T13:38:37.5683295+00:00",
"updated_by_user_id": "51ea125c-894d-4aa2-98dc-d518117fad96",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-02-21T13:38:37.5683295+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-02-21T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-02-21T13:38:37.5683295+00:00",
"date_last_job": "2026-02-21T13:38:37.5683295+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-02-21T13:38:37.5683295+00:00",
"modified_dateutc": "2026-02-21T13:38:37.5683295+00:00",
"is_mobile_installation": true
},
"job_type_id": "16bbce3e-b36f-4234-96a0-ddb0f9668ab7",
"job_type_code": "sample string 7",
"job_type": {
"id": "1621f9dc-4106-4cf2-bc34-72bef4818b5b",
"name": "sample string 2",
"sales_organization_id": "a48e69c1-99cf-4f7a-bf6f-6e25ebe34519",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-02-21T13:38:37.5683295+00:00",
"code": "sample string 7"
},
"job_priority_id": "75ec341a-0b3f-4efb-85dd-d4ceb27d17bd",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "7ffe8e3f-bc1c-44d1-963f-bf8cc824363a",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "1e47584b-8a5f-4470-aeaa-5735f5a215ad",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "49fd5fa7-ab42-4d81-aa5c-9c3e45cd21a1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "79e85a91-ca08-46d7-88d2-810079cb8c6b",
"db_currency_id": "7c4385a9-17a3-4bf8-a01e-8e61bf393aa8",
"db_language_id": "7987cb92-151f-4500-ab0b-022a883b424c",
"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-02-21T13:38:37.5683295+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-21T13:38:37.5683295+00:00"
},
"job_status_id": "909d55fc-0e36-4dff-84c3-5e494471aa94",
"job_status_code": "sample string 11",
"db_address_id": "fbd47081-fb59-4ee0-8b36-53655dd4e3ec",
"contact_id": "873344b9-fe4c-4ac1-a028-bda5a6692501",
"requested_by_company_id": "d998f76d-99c2-402f-9e56-b5e8998f80d0",
"requested_by_contact_id": "eb6c031c-b0ec-4538-bfb6-fa88b466b12c",
"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-02-21T13:38:37.5683295+00:00",
"due_date": "2026-02-21T13:38:37.5683295+00:00",
"date_create": "2026-02-21T13:38:37.5683295+00:00",
"date_update": "2026-02-21T13:38:37.5683295+00:00",
"date_closed": "2026-02-21T13:38:37.5683295+00:00",
"suggested_user_id": "3f494e25-9895-480d-9f9a-408ecf5b06bb",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "aef25b48-8cdc-4071-abe4-37e97e9666a8",
"db_language_id": "cf1298d1-5277-4a89-bd46-50fc23546081",
"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-02-21T13:38:37.5683295+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "1f05d421-38ce-4ee2-814d-71dd2eac2689",
"sales_organization": {
"id": "49fd5fa7-ab42-4d81-aa5c-9c3e45cd21a1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "79e85a91-ca08-46d7-88d2-810079cb8c6b",
"db_currency_id": "7c4385a9-17a3-4bf8-a01e-8e61bf393aa8",
"db_language_id": "7987cb92-151f-4500-ab0b-022a883b424c",
"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-02-21T13:38:37.5683295+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "f609cbc1-3bc1-4d52-bbd7-23e30a9e3734",
"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": "80fc5043-aeb3-4b1f-8f0f-8aa1847a8271",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-02-21T13:38:37.5683295+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "2fdff32c-7d55-43b0-9de1-687ce6eaf145"
},
"suggested_date_start": "2026-02-21T13:38:37.5683295+00:00",
"skill_id": "b28bb17a-cd7d-4cc1-a97c-fcf1f12afae5",
"skill_code": "sample string 32",
"skill": {
"id": "c0662038-b809-43f6-936c-a0fc0480d952",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "98adde5f-816b-4d1a-baaf-53a4145d6dc9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "49fd5fa7-ab42-4d81-aa5c-9c3e45cd21a1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "79e85a91-ca08-46d7-88d2-810079cb8c6b",
"db_currency_id": "7c4385a9-17a3-4bf8-a01e-8e61bf393aa8",
"db_language_id": "7987cb92-151f-4500-ab0b-022a883b424c",
"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-02-21T13:38:37.5683295+00:00"
},
"modified_dateutc": "2026-02-21T13:38:37.5683295+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "fd4f4dc2-a9a3-48ed-875d-4182e3915228",
"date_reported_by_company": "2026-02-21T13:38:37.5683295+00:00",
"id2": 36,
"company_id": "8bc03603-062a-4d02-9092-a1f167166d0e",
"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": "1fcfc87d-3600-4879-ae2b-9d0a45b1d499",
"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-02-21T13:38:37.5683295+00:00"
},
"work_instruction_details_id": "7cd2d7b8-bbe7-4f78-ab9c-c0a7996f02b1",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "af611fd0-0194-4ea5-b237-650b0d026b68",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "108a49de-65fc-45e8-887b-f7609e8b0344",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-02-21T13:38:37.5683295+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": "4b967022-bd6e-4ea6-8902-55009fca56f8",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-02-21T13:38:37.5683295+00:00"
}