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": "cc000b61-1024-4a9a-bb27-57c4c754406b",
"jobs_id": "4ac70191-42ab-4581-a749-1cfa80146902",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "77b7e46d-1de5-462f-b01a-53a079faeb1e",
"_parent_id": "247f5676-9f6b-435e-8cdd-a06e7f48683b",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "a5733f5b-5c94-49be-9089-44532ce88fce",
"project_reference_back_office": "sample string 5",
"project": {
"id": "0294b0c2-44ff-4fdd-b527-1af45d668c6b",
"_parent_id": "8beeae37-fa7a-43b4-b2bd-826b3f151d84",
"root_parent_id": "3a7c4765-2dc6-4e8f-8245-10c0b2f4071b",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "0f87ea60-e066-4b59-8fab-17c0a9f47fce",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "7719188c-1348-4f5d-b1ec-7cdd11d7fa1f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "24583681-903c-455b-aea2-535011e4136e",
"_parent_code": "sample string 6",
"sales_organization_id": "02ef5442-34c3-4cf1-949c-c2888a32f004",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "9d76bf27-de46-47fc-98c6-15f58fe4d0ae",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "33fde20c-fc32-4f9a-8d20-4865e4b70338",
"db_currency_id": "febca3e9-7ab8-4041-84a7-f7d52226238e",
"db_language_id": "3c6ec0f6-b9ce-483c-9805-8ab29803ab12",
"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-06-25T11:51:31.8829452+00:00"
},
"modified_dateutc": "2025-06-25T11:51:31.8829452+00:00"
},
"equipment_model_id": "8c67aafd-3931-4298-9560-c013e5e5f976",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "d0ed07b3-dc89-4517-bbf2-097bda7fbb5b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "4802dfd4-3105-490c-9d0a-2c2235629801",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "b929bf92-853f-42da-be86-e3dcb6322017",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "f0d20ba9-2a08-4f9c-b88d-66929ba2aaab",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9d76bf27-de46-47fc-98c6-15f58fe4d0ae",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "33fde20c-fc32-4f9a-8d20-4865e4b70338",
"db_currency_id": "febca3e9-7ab8-4041-84a7-f7d52226238e",
"db_language_id": "3c6ec0f6-b9ce-483c-9805-8ab29803ab12",
"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-06-25T11:51:31.8829452+00:00"
},
"modified_dateutc": "2025-06-25T11:51:31.8829452+00:00"
},
"equipment_family_id": "d66d6426-d799-43c5-bc3a-0b7453800ec8",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "7719188c-1348-4f5d-b1ec-7cdd11d7fa1f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "24583681-903c-455b-aea2-535011e4136e",
"_parent_code": "sample string 6",
"sales_organization_id": "02ef5442-34c3-4cf1-949c-c2888a32f004",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "9d76bf27-de46-47fc-98c6-15f58fe4d0ae",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "33fde20c-fc32-4f9a-8d20-4865e4b70338",
"db_currency_id": "febca3e9-7ab8-4041-84a7-f7d52226238e",
"db_language_id": "3c6ec0f6-b9ce-483c-9805-8ab29803ab12",
"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-06-25T11:51:31.8829452+00:00"
},
"modified_dateutc": "2025-06-25T11:51:31.8829452+00:00"
},
"date_in_production_since": "2025-06-25T11:51:31.8829452+00:00",
"date_out_of_production_since": "2025-06-25T11:51:31.8829452+00:00",
"date_end_support": "2025-06-25T11:51:31.8829452+00:00",
"sales_organization_id": "9976f8d9-abce-458b-9b12-e3cfa65d0a4f",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "9d76bf27-de46-47fc-98c6-15f58fe4d0ae",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "33fde20c-fc32-4f9a-8d20-4865e4b70338",
"db_currency_id": "febca3e9-7ab8-4041-84a7-f7d52226238e",
"db_language_id": "3c6ec0f6-b9ce-483c-9805-8ab29803ab12",
"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-06-25T11:51:31.8829452+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-06-25T11:51:31.8829452+00:00"
},
"project_status_id": "fba56f53-3ab6-469d-95d2-6ddd47884e8d",
"project_status_code": "sample string 10",
"project_status": {
"id": "05760e92-e545-4091-ac8d-304a111b5753",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "9afb8341-a2b0-4463-aa00-d7ffbf65d06c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9d76bf27-de46-47fc-98c6-15f58fe4d0ae",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "33fde20c-fc32-4f9a-8d20-4865e4b70338",
"db_currency_id": "febca3e9-7ab8-4041-84a7-f7d52226238e",
"db_language_id": "3c6ec0f6-b9ce-483c-9805-8ab29803ab12",
"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-06-25T11:51:31.8829452+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-06-25T11:51:31.8829452+00:00"
},
"company_id": "1f176841-0c45-4866-819c-9c4600272cdf",
"company_code": "sample string 12",
"db_address_id": "79520bfa-5b07-4f20-9783-c0b98d60cf82",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "a1ef0774-7240-4c45-aaeb-cc1881ac3bc7",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "9511de0d-5cbc-426a-8abd-3b6b7f05da6d",
"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-06-25T11:51:31.8829452+00:00",
"date_create": "2025-06-25T11:51:31.8829452+00:00",
"date_update": "2025-06-25T11:51:31.8829452+00:00",
"updated_by_user_id": "bd24ff68-6b64-4a81-aaad-067bd9fe7be3",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-06-25T11:51:31.8829452+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-06-25T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-06-25T11:51:31.8829452+00:00",
"date_last_job": "2025-06-25T11:51:31.8829452+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-06-25T11:51:31.8829452+00:00",
"modified_dateutc": "2025-06-25T11:51:31.8829452+00:00",
"is_mobile_installation": true
},
"job_type_id": "87453621-a10f-43ce-80e5-ba26495b222f",
"job_type_code": "sample string 7",
"job_type": {
"id": "22ba7af0-585a-4ad0-bdae-d2ae6a566167",
"name": "sample string 2",
"sales_organization_id": "ec616fa4-9bd7-4a56-97d0-987ce3b68faa",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-06-25T11:51:31.8829452+00:00",
"code": "sample string 7"
},
"job_priority_id": "e9d67f45-2ce7-443c-9c37-879da0f1656a",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "f7a59a08-312a-44a5-ab41-47d77b186afc",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "4353ca8c-8a46-44db-b4ea-6d654ea1bbbc",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9d76bf27-de46-47fc-98c6-15f58fe4d0ae",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "33fde20c-fc32-4f9a-8d20-4865e4b70338",
"db_currency_id": "febca3e9-7ab8-4041-84a7-f7d52226238e",
"db_language_id": "3c6ec0f6-b9ce-483c-9805-8ab29803ab12",
"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-06-25T11:51:31.8829452+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-06-25T11:51:31.8829452+00:00"
},
"job_status_id": "e969a663-4bbc-4b06-9051-b90973bcdc34",
"job_status_code": "sample string 11",
"db_address_id": "f67c5d47-9a5f-4bcb-aa41-1bfcd23729aa",
"contact_id": "f1bc40fe-4e30-4b65-aabb-cc9ae06be002",
"requested_by_company_id": "f57738d7-2a41-4bb9-9673-afcdf322295b",
"requested_by_contact_id": "d57394b7-4e5e-43fa-9ed8-e091f78b9245",
"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-06-25T11:51:31.8829452+00:00",
"due_date": "2025-06-25T11:51:31.8829452+00:00",
"date_create": "2025-06-25T11:51:31.8829452+00:00",
"date_update": "2025-06-25T11:51:31.8829452+00:00",
"date_closed": "2025-06-25T11:51:31.8829452+00:00",
"suggested_user_id": "337c7f83-f0cc-4ff2-92b8-122e4f4de53d",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "ab3210f1-90bb-4e55-be4d-fcc397401a61",
"db_language_id": "4b3c65df-e5b0-4a26-bfef-e497eedc803c",
"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-06-25T11:51:31.8829452+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "0d50403a-dd6b-434e-8694-0f9e1ae1a318",
"sales_organization": {
"id": "9d76bf27-de46-47fc-98c6-15f58fe4d0ae",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "33fde20c-fc32-4f9a-8d20-4865e4b70338",
"db_currency_id": "febca3e9-7ab8-4041-84a7-f7d52226238e",
"db_language_id": "3c6ec0f6-b9ce-483c-9805-8ab29803ab12",
"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-06-25T11:51:31.8829452+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "5abae34e-76c8-4075-989f-54510c68e1ee",
"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": "5603d870-bce0-4c7d-8ac0-511f984d1a0b",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-06-25T11:51:31.8829452+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "f081698c-4edb-4ddd-ad1a-d59d06b2765f"
},
"suggested_date_start": "2025-06-25T11:51:31.8829452+00:00",
"skill_id": "17a16478-ccaa-44ea-9891-1aef850e7dcc",
"skill_code": "sample string 32",
"skill": {
"id": "7bb98a55-3743-4008-be1b-0003fd251a3b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "21c0e726-b594-4543-8188-b37854252396",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9d76bf27-de46-47fc-98c6-15f58fe4d0ae",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "33fde20c-fc32-4f9a-8d20-4865e4b70338",
"db_currency_id": "febca3e9-7ab8-4041-84a7-f7d52226238e",
"db_language_id": "3c6ec0f6-b9ce-483c-9805-8ab29803ab12",
"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-06-25T11:51:31.8829452+00:00"
},
"modified_dateutc": "2025-06-25T11:51:31.8829452+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "d8e8eadb-9297-4236-bc60-50a1a74f8e00",
"date_reported_by_company": "2025-06-25T11:51:31.8829452+00:00",
"id2": 36,
"company_id": "d5fda867-72c7-4f2b-8ad2-ada205935c53",
"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": "badf9bd6-5958-4f7b-a9f0-a229a244e222",
"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-06-25T11:51:31.8829452+00:00"
},
"work_instruction_details_id": "ab21bb22-900f-46c0-bbc1-3469c32ba695",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "a745eece-8c9e-4b5b-9fa6-eadd6d568285",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "d1517b91-6192-4733-998d-b53936fc29cd",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-06-25T11:51:31.8829452+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": "20fed457-55b0-4628-a030-113e4dba8eeb",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-06-25T11:51:31.8829452+00:00"
}