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": "53a1df47-1687-43c5-870a-39e47a3d7945",
"jobs_id": "dc918c24-9976-40a2-801b-c7255988e90b",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "c399f0f4-7c74-4b9d-92f2-1e72a152547a",
"_parent_id": "7eb4dbc9-e124-4fd9-a15b-b48558315a81",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "a115fd1d-645d-49d3-bfa9-bb7e7e142552",
"project_reference_back_office": "sample string 5",
"project": {
"id": "a19e9809-de48-453e-81cc-4cf14c3814fb",
"_parent_id": "1bd64451-7561-4a4d-b00b-4b0b534dacfa",
"root_parent_id": "61b68288-6bf6-4af1-8c36-d69bdf8843e9",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "a71a83b0-8db2-470d-aea0-74b049d9b6c7",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "dd60b1fc-cf85-4c43-95cf-cefea61c703b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "6234f924-c4e3-4d06-86d5-247320387b56",
"_parent_code": "sample string 6",
"sales_organization_id": "ecacbb47-5f8a-48fa-a8e8-de5c62c65782",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "debc33ca-398d-4f87-a4cb-b7b106905c32",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a9e8afbb-fa14-407f-b1e7-4eed6e211d82",
"db_currency_id": "ffa4dadc-8e37-4d9e-bb54-aa8bb5b8c4cb",
"db_language_id": "7d35f55e-4f0f-4a95-87b7-5e8d1668bb0c",
"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-04-26T07:46:35.8537988+00:00"
},
"modified_dateutc": "2026-04-26T07:46:35.8537988+00:00"
},
"equipment_model_id": "cce86c17-efc1-4fab-b5cf-be6bf364b38f",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "0df6609e-6ad9-4203-8c18-b84e58f0f2b9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "08feed81-1726-469c-8579-a2f1066c82a9",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "fcb9bdde-3dd9-48b7-b4ee-96b7570ba9c5",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "cc81ba04-5b59-4991-a94f-e632373acc4e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "debc33ca-398d-4f87-a4cb-b7b106905c32",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a9e8afbb-fa14-407f-b1e7-4eed6e211d82",
"db_currency_id": "ffa4dadc-8e37-4d9e-bb54-aa8bb5b8c4cb",
"db_language_id": "7d35f55e-4f0f-4a95-87b7-5e8d1668bb0c",
"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-04-26T07:46:35.8537988+00:00"
},
"modified_dateutc": "2026-04-26T07:46:35.8537988+00:00"
},
"equipment_family_id": "a46d23bd-354f-43d8-81a9-5dbaf3c60819",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "dd60b1fc-cf85-4c43-95cf-cefea61c703b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "6234f924-c4e3-4d06-86d5-247320387b56",
"_parent_code": "sample string 6",
"sales_organization_id": "ecacbb47-5f8a-48fa-a8e8-de5c62c65782",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "debc33ca-398d-4f87-a4cb-b7b106905c32",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a9e8afbb-fa14-407f-b1e7-4eed6e211d82",
"db_currency_id": "ffa4dadc-8e37-4d9e-bb54-aa8bb5b8c4cb",
"db_language_id": "7d35f55e-4f0f-4a95-87b7-5e8d1668bb0c",
"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-04-26T07:46:35.8537988+00:00"
},
"modified_dateutc": "2026-04-26T07:46:35.8537988+00:00"
},
"date_in_production_since": "2026-04-26T07:46:35.8537988+00:00",
"date_out_of_production_since": "2026-04-26T07:46:35.8537988+00:00",
"date_end_support": "2026-04-26T07:46:35.8537988+00:00",
"sales_organization_id": "32e8b861-d1b7-4826-acf0-d64efe26f62e",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "debc33ca-398d-4f87-a4cb-b7b106905c32",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a9e8afbb-fa14-407f-b1e7-4eed6e211d82",
"db_currency_id": "ffa4dadc-8e37-4d9e-bb54-aa8bb5b8c4cb",
"db_language_id": "7d35f55e-4f0f-4a95-87b7-5e8d1668bb0c",
"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-04-26T07:46:35.8537988+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-04-26T07:46:35.8537988+00:00"
},
"project_status_id": "677f6d48-0ca9-4c29-bd2b-cb17342a808d",
"project_status_code": "sample string 10",
"project_status": {
"id": "9f37632e-10e0-4605-b4aa-dfa5e1e8b3e2",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "5701fdb5-6121-4d07-bc09-2e43d1c13ac8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "debc33ca-398d-4f87-a4cb-b7b106905c32",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a9e8afbb-fa14-407f-b1e7-4eed6e211d82",
"db_currency_id": "ffa4dadc-8e37-4d9e-bb54-aa8bb5b8c4cb",
"db_language_id": "7d35f55e-4f0f-4a95-87b7-5e8d1668bb0c",
"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-04-26T07:46:35.8537988+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-26T07:46:35.8537988+00:00"
},
"company_id": "21b5c54c-172e-4300-93db-d2832e257b9a",
"company_code": "sample string 12",
"db_address_id": "5dbb77fb-5c02-477a-8026-6b3746f760fc",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "918d17b5-ee2e-426f-a78b-8eef88b7ac3a",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "f57bd9f0-5167-4135-8c87-0d3a9b8ac477",
"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-04-26T07:46:35.8537988+00:00",
"date_create": "2026-04-26T07:46:35.8537988+00:00",
"date_update": "2026-04-26T07:46:35.8537988+00:00",
"updated_by_user_id": "f1b506c9-45eb-4b85-9379-ddc70408f9fa",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-04-26T07:46:35.8537988+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-04-26T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-04-26T07:46:35.8537988+00:00",
"date_last_job": "2026-04-26T07:46:35.8537988+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-04-26T07:46:35.8537988+00:00",
"modified_dateutc": "2026-04-26T07:46:35.8537988+00:00",
"is_mobile_installation": true
},
"job_type_id": "5a6e11ba-8f92-4a5d-8a1f-ce8e72d16e7b",
"job_type_code": "sample string 7",
"job_type": {
"id": "67c1f6cc-afee-4255-bac2-a9500981a728",
"name": "sample string 2",
"sales_organization_id": "bf613a86-556f-43a1-8a9f-f2e4bf9bbc7d",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-04-26T07:46:35.8537988+00:00",
"code": "sample string 7"
},
"job_priority_id": "6d7da12d-3120-4af3-8be8-1af4aa08dbb8",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "def2c02f-4081-44b2-a357-182f7db74ef2",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "2bea4c83-2958-441f-ad8e-8081845e6d78",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "debc33ca-398d-4f87-a4cb-b7b106905c32",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a9e8afbb-fa14-407f-b1e7-4eed6e211d82",
"db_currency_id": "ffa4dadc-8e37-4d9e-bb54-aa8bb5b8c4cb",
"db_language_id": "7d35f55e-4f0f-4a95-87b7-5e8d1668bb0c",
"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-04-26T07:46:35.8537988+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-26T07:46:35.8537988+00:00"
},
"job_status_id": "7e652f6f-2ef5-40e3-a0e7-93678bae6331",
"job_status_code": "sample string 11",
"db_address_id": "b2af47ad-6a4d-4bb9-815a-23079cc65929",
"contact_id": "ce733eda-451a-49da-92e3-d495a847b1e5",
"requested_by_company_id": "1fca3b5e-7582-443b-b41d-3070f1910b84",
"requested_by_contact_id": "c2e18118-a320-4093-8f3e-082c9c247b9a",
"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-04-26T07:46:35.8537988+00:00",
"due_date": "2026-04-26T07:46:35.8537988+00:00",
"date_create": "2026-04-26T07:46:35.8537988+00:00",
"date_update": "2026-04-26T07:46:35.8537988+00:00",
"date_closed": "2026-04-26T07:46:35.8537988+00:00",
"suggested_user_id": "1ea57f41-3ad7-4d7e-a1d3-fb0294713c60",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "ff9ab1ac-802f-4196-879f-28420ff63601",
"db_language_id": "0af35324-3bf4-4e3e-a6af-079b6f9d4931",
"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-04-26T07:46:35.8537988+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "8a99955f-3858-4c9b-8864-3a569c9792b2",
"sales_organization": {
"id": "debc33ca-398d-4f87-a4cb-b7b106905c32",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a9e8afbb-fa14-407f-b1e7-4eed6e211d82",
"db_currency_id": "ffa4dadc-8e37-4d9e-bb54-aa8bb5b8c4cb",
"db_language_id": "7d35f55e-4f0f-4a95-87b7-5e8d1668bb0c",
"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-04-26T07:46:35.8537988+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "4379087c-3451-4ca0-a2e7-f9d01c2368c6",
"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": "72735772-3f3b-4031-b7ea-dfbe98bc61de",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-04-26T07:46:35.8537988+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "eca1de26-9126-414d-a0d0-5858e1818966"
},
"suggested_date_start": "2026-04-26T07:46:35.8537988+00:00",
"skill_id": "66a43b78-7e3e-4bd5-b3ea-1b60a4956363",
"skill_code": "sample string 32",
"skill": {
"id": "2edb84ea-4aaf-47fe-a761-3f72fdc7f2c5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "f5cf2fa1-c409-4dee-b360-e6c62a70ac1b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "debc33ca-398d-4f87-a4cb-b7b106905c32",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a9e8afbb-fa14-407f-b1e7-4eed6e211d82",
"db_currency_id": "ffa4dadc-8e37-4d9e-bb54-aa8bb5b8c4cb",
"db_language_id": "7d35f55e-4f0f-4a95-87b7-5e8d1668bb0c",
"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-04-26T07:46:35.8537988+00:00"
},
"modified_dateutc": "2026-04-26T07:46:35.8537988+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "fda64d8f-47d4-435a-a5e6-cb6f0f8abca5",
"date_reported_by_company": "2026-04-26T07:46:35.8537988+00:00",
"id2": 36,
"company_id": "797464c8-6679-40d8-b7a0-44c600914f52",
"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": "4637a02f-3313-41c2-bf92-c631efab1287",
"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-04-26T07:46:35.8537988+00:00"
},
"work_instruction_details_id": "1ab27fd7-1ba1-45c3-ab76-a0703344a790",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "45e8e14b-5438-4f5e-82cb-2d30e6bc7a04",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "88ca7f31-e0d2-45fa-80d9-47788ca8eb4b",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-04-26T07:46:35.8537988+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": "0091e75b-337b-4fa8-aa44-84ac80ce33c5",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-04-26T07:46:35.8537988+00:00"
}