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": "eba70271-926f-4dfd-8495-589c6b08f261",
"jobs_id": "8b7f0c0f-3f3a-4039-8439-837b00f00142",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "f2aaf226-60f2-4504-b22f-47e438c5490d",
"_parent_id": "d99a3417-bc1f-4696-8b5b-17d17d745663",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "0eab7644-01be-4433-a186-4dfc38b16eb1",
"project_reference_back_office": "sample string 5",
"project": {
"id": "1e337376-e4f3-4c6f-85fa-e277d2a8606f",
"_parent_id": "1e71fc6b-36ed-4c65-a2cc-4db0da9a082d",
"root_parent_id": "3511f46c-1f95-4860-ac30-b843965dc6cd",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "ec93db3e-8361-450e-ac3b-fc0e10f52452",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "67f19426-8d63-4b64-8713-0c174eb268b8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "20bb562f-cd74-4aa9-aa56-7026b12b06b9",
"_parent_code": "sample string 6",
"sales_organization_id": "b68e3c00-1057-468d-b96f-366ccd579236",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e388bcc9-d885-43a7-a5b0-8c9f1481d818",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "112ade95-fd04-4aa0-b4bb-79d9e4c61d51",
"db_currency_id": "da7431ee-aba0-4dac-b797-b3fed3d34d24",
"db_language_id": "ee011372-a0c8-49b1-bddc-d192703edef8",
"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-02T04:57:31.0012448+00:00"
},
"modified_dateutc": "2026-05-02T04:57:31.0012448+00:00"
},
"equipment_model_id": "12df04c6-00bc-4cb2-a53d-7cc33bbc6b3b",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "c8a031fa-da6e-411c-8abc-ecadc9e0a763",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "d27e6f63-284d-45c4-b7eb-baacd51f35d5",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "7d3ec1c8-c23c-423a-87e2-d512f507a712",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "767ffb01-2ba3-4c88-b410-8fda3d7dd20a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e388bcc9-d885-43a7-a5b0-8c9f1481d818",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "112ade95-fd04-4aa0-b4bb-79d9e4c61d51",
"db_currency_id": "da7431ee-aba0-4dac-b797-b3fed3d34d24",
"db_language_id": "ee011372-a0c8-49b1-bddc-d192703edef8",
"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-02T04:57:31.0012448+00:00"
},
"modified_dateutc": "2026-05-02T04:57:31.0012448+00:00"
},
"equipment_family_id": "faaa7698-3226-4402-a5ea-8886cb38a700",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "67f19426-8d63-4b64-8713-0c174eb268b8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "20bb562f-cd74-4aa9-aa56-7026b12b06b9",
"_parent_code": "sample string 6",
"sales_organization_id": "b68e3c00-1057-468d-b96f-366ccd579236",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e388bcc9-d885-43a7-a5b0-8c9f1481d818",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "112ade95-fd04-4aa0-b4bb-79d9e4c61d51",
"db_currency_id": "da7431ee-aba0-4dac-b797-b3fed3d34d24",
"db_language_id": "ee011372-a0c8-49b1-bddc-d192703edef8",
"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-02T04:57:31.0012448+00:00"
},
"modified_dateutc": "2026-05-02T04:57:31.0012448+00:00"
},
"date_in_production_since": "2026-05-02T04:57:31.0012448+00:00",
"date_out_of_production_since": "2026-05-02T04:57:31.0012448+00:00",
"date_end_support": "2026-05-02T04:57:31.0012448+00:00",
"sales_organization_id": "c476fc97-ea98-4b32-b9b2-2c977085ebf8",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "e388bcc9-d885-43a7-a5b0-8c9f1481d818",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "112ade95-fd04-4aa0-b4bb-79d9e4c61d51",
"db_currency_id": "da7431ee-aba0-4dac-b797-b3fed3d34d24",
"db_language_id": "ee011372-a0c8-49b1-bddc-d192703edef8",
"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-02T04:57:31.0012448+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-02T04:57:31.0012448+00:00"
},
"project_status_id": "e513db60-6ff0-48ea-ae0c-473b6fa12957",
"project_status_code": "sample string 10",
"project_status": {
"id": "64787161-740b-429c-b5b8-e49371cbea82",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "7191343a-cba2-4964-87ae-cd5d03be4f4f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e388bcc9-d885-43a7-a5b0-8c9f1481d818",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "112ade95-fd04-4aa0-b4bb-79d9e4c61d51",
"db_currency_id": "da7431ee-aba0-4dac-b797-b3fed3d34d24",
"db_language_id": "ee011372-a0c8-49b1-bddc-d192703edef8",
"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-02T04:57:31.0012448+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-02T04:57:31.0012448+00:00"
},
"company_id": "864f2cc4-e347-474f-999f-7822b1c70a33",
"company_code": "sample string 12",
"db_address_id": "edd5ed05-f5b0-477c-b433-c439ef6ef9a4",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "a237d80b-da4e-4241-82ae-a1a62d80c779",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "4418c232-dc39-4b37-a74d-b64838318809",
"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-02T04:57:31.0012448+00:00",
"date_create": "2026-05-02T04:57:31.0012448+00:00",
"date_update": "2026-05-02T04:57:31.0012448+00:00",
"updated_by_user_id": "965116b9-3288-4bdb-a25b-e0a1d59540e1",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-02T04:57:31.0012448+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-02T04:57:31.0012448+00:00",
"date_last_job": "2026-05-02T04:57:31.0012448+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-02T04:57:31.0012448+00:00",
"modified_dateutc": "2026-05-02T04:57:31.0012448+00:00",
"is_mobile_installation": true
},
"job_type_id": "c6b0cd2f-9838-498d-a9fc-8f23272c22b6",
"job_type_code": "sample string 7",
"job_type": {
"id": "1c7449f8-2617-4cdf-b1c6-4513424b4328",
"name": "sample string 2",
"sales_organization_id": "07f71f19-e48d-43fa-ac12-9ead75bbe3d1",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-02T04:57:31.0012448+00:00",
"code": "sample string 7"
},
"job_priority_id": "797f84ac-f68a-45cd-bf99-471db7274632",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "e911d449-b6a4-45ae-8fa6-67d4625ed219",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "c94d2977-0c40-46ca-9947-74dcb6bd7396",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e388bcc9-d885-43a7-a5b0-8c9f1481d818",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "112ade95-fd04-4aa0-b4bb-79d9e4c61d51",
"db_currency_id": "da7431ee-aba0-4dac-b797-b3fed3d34d24",
"db_language_id": "ee011372-a0c8-49b1-bddc-d192703edef8",
"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-02T04:57:31.0012448+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-02T04:57:31.0012448+00:00"
},
"job_status_id": "8ee8e177-a5d6-4f91-8e84-f90f3729374c",
"job_status_code": "sample string 11",
"db_address_id": "049f9698-3db8-47d5-83d1-8bb305d38b8e",
"contact_id": "a74e1ea6-0bd6-4d8f-8ae6-d2c1994faae2",
"requested_by_company_id": "390fb682-f771-4be0-9794-0d4e3835f7d5",
"requested_by_contact_id": "f8abf078-1200-4b26-8abf-4d25a60a2895",
"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-02T04:57:31.0012448+00:00",
"due_date": "2026-05-02T04:57:31.0012448+00:00",
"date_create": "2026-05-02T04:57:31.0012448+00:00",
"date_update": "2026-05-02T04:57:31.0012448+00:00",
"date_closed": "2026-05-02T04:57:31.0012448+00:00",
"suggested_user_id": "66434813-3690-4ab4-81ed-49f8e8de5759",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "b865f02a-760e-4acc-91dc-953b3e5d424d",
"db_language_id": "0fd63649-0151-4818-bb94-3010d81b410a",
"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-02T04:57:31.0168691+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "6e03588a-0085-4dd5-8fc2-82921f2a94f6",
"sales_organization": {
"id": "e388bcc9-d885-43a7-a5b0-8c9f1481d818",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "112ade95-fd04-4aa0-b4bb-79d9e4c61d51",
"db_currency_id": "da7431ee-aba0-4dac-b797-b3fed3d34d24",
"db_language_id": "ee011372-a0c8-49b1-bddc-d192703edef8",
"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-02T04:57:31.0012448+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "18514714-8200-4908-9e90-b9451b3e5abd",
"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": "19f44b44-509f-4d0a-8a15-97777f62ec12",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-02T04:57:31.0168691+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "1c50f3d0-fedc-4f31-81c5-58eca86d6b0f"
},
"suggested_date_start": "2026-05-02T04:57:31.0168691+00:00",
"skill_id": "939c1f80-6bca-4a7e-ae54-77e21bca6959",
"skill_code": "sample string 32",
"skill": {
"id": "861beaf5-6086-44fb-9758-905bc2efab09",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "313ebcf9-20fb-40c1-8df1-995ba1f9d046",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e388bcc9-d885-43a7-a5b0-8c9f1481d818",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "112ade95-fd04-4aa0-b4bb-79d9e4c61d51",
"db_currency_id": "da7431ee-aba0-4dac-b797-b3fed3d34d24",
"db_language_id": "ee011372-a0c8-49b1-bddc-d192703edef8",
"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-02T04:57:31.0012448+00:00"
},
"modified_dateutc": "2026-05-02T04:57:31.0168691+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "083ca19d-bdac-4e7e-840b-4bc4879101b5",
"date_reported_by_company": "2026-05-02T04:57:31.0168691+00:00",
"id2": 36,
"company_id": "cacdc424-62c7-4351-8db3-38898d651d6e",
"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": "25e40102-0922-4eea-a90a-c9ab8d19f4ee",
"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-02T04:57:31.0168691+00:00"
},
"work_instruction_details_id": "1e57a5a6-4826-4074-a09b-35e9a6f9b87b",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "16e2ae98-0c6a-498f-938f-95b52307fc9d",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "9bb0e75d-be5e-452b-a405-43598a135c8d",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-02T04:57:31.0168691+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": "35d0e4af-2893-4481-a9f8-a0784a3d0e1b",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-02T04:57:31.0168691+00:00"
}