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": "1936d1a9-4d97-4023-a190-60c0b7da2618",
"jobs_id": "bff494d2-9543-40d1-979a-831d9326162e",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "1966f50d-271a-4104-b9d0-9b455e334d1e",
"_parent_id": "d965fe7f-7615-4d63-b964-756f8673ded6",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "ce7f1f4d-1cb8-497b-8ec8-860e1fb786c1",
"project_reference_back_office": "sample string 5",
"project": {
"id": "dfb36ec1-1a72-43f1-bae2-5191f10c3abf",
"_parent_id": "c3d9d3aa-a5b9-4111-ab29-8361cdcc8ef7",
"root_parent_id": "f5455d09-20f8-4724-8d0c-cb6f3ab6a47a",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "91f02ce8-c4a9-46cb-9324-4af0eaf42bba",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "e5521275-90dd-430e-af45-da01ba1f8e98",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "358b33e1-57d0-434e-abec-764cebbca92e",
"_parent_code": "sample string 6",
"sales_organization_id": "f25b9a0b-db2a-4bca-835c-7afab689c00d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "34dcb389-2baa-461a-9259-3c2bf5777b3c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "656dce57-789d-4d89-a9d2-cb6761f485a9",
"db_currency_id": "43844ad5-395e-4757-b12f-a05981dbcb5b",
"db_language_id": "c45f065a-6f21-4376-8794-99ae3d45f89c",
"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-06-11T16:18:19.5581165+00:00"
},
"modified_dateutc": "2026-06-11T16:18:19.5581165+00:00"
},
"equipment_model_id": "d3ef342e-f7fe-4692-b69a-fdf975408d4d",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "9617c17d-7678-4178-a308-a63df148d94d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "3a872030-15c9-4964-9395-542fa9aa85f3",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "33708b36-b907-491a-9a21-55ce717fd8f1",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "13bcaa35-4673-4c66-bdf3-da605c3f8a1c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "34dcb389-2baa-461a-9259-3c2bf5777b3c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "656dce57-789d-4d89-a9d2-cb6761f485a9",
"db_currency_id": "43844ad5-395e-4757-b12f-a05981dbcb5b",
"db_language_id": "c45f065a-6f21-4376-8794-99ae3d45f89c",
"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-06-11T16:18:19.5581165+00:00"
},
"modified_dateutc": "2026-06-11T16:18:19.5581165+00:00"
},
"equipment_family_id": "0fb102a0-de72-491c-a81a-bb7f89a3c885",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "e5521275-90dd-430e-af45-da01ba1f8e98",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "358b33e1-57d0-434e-abec-764cebbca92e",
"_parent_code": "sample string 6",
"sales_organization_id": "f25b9a0b-db2a-4bca-835c-7afab689c00d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "34dcb389-2baa-461a-9259-3c2bf5777b3c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "656dce57-789d-4d89-a9d2-cb6761f485a9",
"db_currency_id": "43844ad5-395e-4757-b12f-a05981dbcb5b",
"db_language_id": "c45f065a-6f21-4376-8794-99ae3d45f89c",
"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-06-11T16:18:19.5581165+00:00"
},
"modified_dateutc": "2026-06-11T16:18:19.5581165+00:00"
},
"date_in_production_since": "2026-06-11T16:18:19.5581165+00:00",
"date_out_of_production_since": "2026-06-11T16:18:19.5581165+00:00",
"date_end_support": "2026-06-11T16:18:19.5581165+00:00",
"sales_organization_id": "8db57869-ae2e-4aac-b4f9-3c1b80478735",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "34dcb389-2baa-461a-9259-3c2bf5777b3c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "656dce57-789d-4d89-a9d2-cb6761f485a9",
"db_currency_id": "43844ad5-395e-4757-b12f-a05981dbcb5b",
"db_language_id": "c45f065a-6f21-4376-8794-99ae3d45f89c",
"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-06-11T16:18:19.5581165+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-06-11T16:18:19.5581165+00:00"
},
"project_status_id": "89bd9dd7-d65e-4a79-8521-bc85e585e2a5",
"project_status_code": "sample string 10",
"project_status": {
"id": "6e2f0ea4-37d5-49a4-9e15-8e05c982fb76",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "cb10b7eb-46cd-4760-88c1-b021d5961768",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "34dcb389-2baa-461a-9259-3c2bf5777b3c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "656dce57-789d-4d89-a9d2-cb6761f485a9",
"db_currency_id": "43844ad5-395e-4757-b12f-a05981dbcb5b",
"db_language_id": "c45f065a-6f21-4376-8794-99ae3d45f89c",
"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-06-11T16:18:19.5581165+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-11T16:18:19.5581165+00:00"
},
"company_id": "39cc4936-074a-461f-ab54-0922102ddca8",
"company_code": "sample string 12",
"db_address_id": "8c11624e-ae93-41ce-a49d-fe176b37ffad",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "d928c49a-0f90-477c-911e-4f722b8dd2ee",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "2e55c792-e9a0-451b-ae48-885027990224",
"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-06-11T16:18:19.5581165+00:00",
"date_create": "2026-06-11T16:18:19.5581165+00:00",
"date_update": "2026-06-11T16:18:19.5581165+00:00",
"updated_by_user_id": "3e9bfacf-46d9-4f7e-9c6b-ff70e132a34d",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-11T16:18:19.5581165+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-06-11T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-11T16:18:19.5581165+00:00",
"date_last_job": "2026-06-11T16:18:19.5581165+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-11T16:18:19.5581165+00:00",
"modified_dateutc": "2026-06-11T16:18:19.5581165+00:00",
"is_mobile_installation": true
},
"job_type_id": "5b9ddf91-b6d7-4631-86cd-e08497eac567",
"job_type_code": "sample string 7",
"job_type": {
"id": "8f778c03-5e2e-4569-ab57-87e81bd3cffa",
"name": "sample string 2",
"sales_organization_id": "8fbe5f28-947d-469e-9584-d467d3686ff7",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-06-11T16:18:19.5581165+00:00",
"code": "sample string 7"
},
"job_priority_id": "7c7e53fc-2f41-46d7-b5e7-5a40d10ca61c",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "1d467827-b1b9-458b-9c75-58ddf6a5ba4d",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "12520d71-9716-4cb7-b9ea-54287467e48c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "34dcb389-2baa-461a-9259-3c2bf5777b3c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "656dce57-789d-4d89-a9d2-cb6761f485a9",
"db_currency_id": "43844ad5-395e-4757-b12f-a05981dbcb5b",
"db_language_id": "c45f065a-6f21-4376-8794-99ae3d45f89c",
"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-06-11T16:18:19.5581165+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-11T16:18:19.5581165+00:00"
},
"job_status_id": "42428ef8-7b62-4f63-9f0e-dafa6b689cf5",
"job_status_code": "sample string 11",
"db_address_id": "57cd03ef-3b1a-43e2-abe4-f0fc2bc9e4dd",
"contact_id": "0652bb30-a482-4a9f-9979-ce5e583aa869",
"requested_by_company_id": "052872e2-d410-4182-8c8d-88705ff0389c",
"requested_by_contact_id": "a1ad8123-7f13-4358-a7ef-312aa15bed3b",
"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-06-11T16:18:19.5581165+00:00",
"due_date": "2026-06-11T16:18:19.5581165+00:00",
"date_create": "2026-06-11T16:18:19.5581165+00:00",
"date_update": "2026-06-11T16:18:19.5581165+00:00",
"date_closed": "2026-06-11T16:18:19.5581165+00:00",
"suggested_user_id": "0a5d8f01-32b6-4552-95b8-7aafae1bdd7d",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "14f0a1a0-0df1-4a25-bf6d-bc254d1d7f23",
"db_language_id": "c973bc68-de21-4242-8d35-9021625f88ab",
"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-06-11T16:18:19.5581165+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "7444bd1c-5068-47e6-885c-e6fa862db3dd",
"sales_organization": {
"id": "34dcb389-2baa-461a-9259-3c2bf5777b3c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "656dce57-789d-4d89-a9d2-cb6761f485a9",
"db_currency_id": "43844ad5-395e-4757-b12f-a05981dbcb5b",
"db_language_id": "c45f065a-6f21-4376-8794-99ae3d45f89c",
"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-06-11T16:18:19.5581165+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "15521b5c-25c5-4af7-a306-a9c9be673e1b",
"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": "cc2f07d9-480c-4f42-b955-6f9e06b3b2a3",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-06-11T16:18:19.5581165+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "b3e1a8a6-7992-42a9-b52a-f4362b98e981"
},
"suggested_date_start": "2026-06-11T16:18:19.5581165+00:00",
"skill_id": "005edf68-7414-43b5-a8c0-2b2e0191fe50",
"skill_code": "sample string 32",
"skill": {
"id": "c18101b3-37b2-4714-88ec-37e59c3d9f8a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "02a92bd2-7506-4c67-bba0-4eada65e6549",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "34dcb389-2baa-461a-9259-3c2bf5777b3c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "656dce57-789d-4d89-a9d2-cb6761f485a9",
"db_currency_id": "43844ad5-395e-4757-b12f-a05981dbcb5b",
"db_language_id": "c45f065a-6f21-4376-8794-99ae3d45f89c",
"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-06-11T16:18:19.5581165+00:00"
},
"modified_dateutc": "2026-06-11T16:18:19.5581165+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "0ea0137f-ddd7-4074-afa5-53cb2dd63738",
"date_reported_by_company": "2026-06-11T16:18:19.5581165+00:00",
"id2": 36,
"company_id": "57c0efa9-2988-4e9f-8fc6-94a880a86a47",
"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": "471c477c-9d5d-40a4-b55c-07b1fc0f9b9b",
"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-06-11T16:18:19.5581165+00:00"
},
"work_instruction_details_id": "0661d0b8-738d-438e-a86b-3bf4941eee3a",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "5967bdc9-13d3-418a-b441-3c27880b511f",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "0b05c384-2e45-4e27-8af7-52d2b54c7f55",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-06-11T16:18:19.5581165+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": "1f9ab35d-fae4-453f-8d3b-7e2f0009058e",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-06-11T16:18:19.5581165+00:00"
}