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": "6667817a-c191-480d-ad7d-043aca5c4301",
"jobs_id": "f326ff68-b6d8-4845-9f94-03a5c21e4d57",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "6788cc62-92b0-41fa-9ea9-7f28ccb6f5ab",
"_parent_id": "f7232b4d-0591-4949-895a-ba60021a778f",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "a075642e-dd57-4535-85a7-f32d07eb859f",
"project_reference_back_office": "sample string 5",
"project": {
"id": "32e0dd01-7681-43f6-9fde-94b09fd4e104",
"_parent_id": "dd89c769-711f-4f17-9b16-e9daed7d1b2f",
"root_parent_id": "4dc85ab1-d96a-43af-a483-688c0bfb0803",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "2292547b-0464-4406-bbaa-7ef5ecc7701c",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "79fb2a9b-cf8e-4150-9324-d6a5308b79aa",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "8f27af73-8123-4780-af4a-143a6b50444c",
"_parent_code": "sample string 6",
"sales_organization_id": "751b2810-3819-4007-9e21-d6db4e932fca",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b9391057-ce78-4722-aedf-2d2988aab054",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c5cd6676-764c-4fba-977e-5e9550ded268",
"db_currency_id": "61ca0bb5-3b55-4f1d-8dc0-b4c36bdda195",
"db_language_id": "697fce95-4752-496c-93bb-c235d547f6ad",
"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-30T12:00:44.4000382+00:00"
},
"modified_dateutc": "2026-05-30T12:00:44.4000382+00:00"
},
"equipment_model_id": "6491d8d1-6523-47a5-8894-bd37db30b560",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "51075c51-7ee4-4dad-a635-ee93a879d587",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "f92e26ae-ee26-4132-9c6d-0a2249d3538b",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "b9577625-8255-44fd-a26f-3552245241a5",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "564e9cc6-6c90-4af2-8029-4006fd66bd7d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b9391057-ce78-4722-aedf-2d2988aab054",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c5cd6676-764c-4fba-977e-5e9550ded268",
"db_currency_id": "61ca0bb5-3b55-4f1d-8dc0-b4c36bdda195",
"db_language_id": "697fce95-4752-496c-93bb-c235d547f6ad",
"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-30T12:00:44.4000382+00:00"
},
"modified_dateutc": "2026-05-30T12:00:44.4000382+00:00"
},
"equipment_family_id": "c799bfca-ad46-4717-9a71-0868a7f72899",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "79fb2a9b-cf8e-4150-9324-d6a5308b79aa",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "8f27af73-8123-4780-af4a-143a6b50444c",
"_parent_code": "sample string 6",
"sales_organization_id": "751b2810-3819-4007-9e21-d6db4e932fca",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b9391057-ce78-4722-aedf-2d2988aab054",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c5cd6676-764c-4fba-977e-5e9550ded268",
"db_currency_id": "61ca0bb5-3b55-4f1d-8dc0-b4c36bdda195",
"db_language_id": "697fce95-4752-496c-93bb-c235d547f6ad",
"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-30T12:00:44.4000382+00:00"
},
"modified_dateutc": "2026-05-30T12:00:44.4000382+00:00"
},
"date_in_production_since": "2026-05-30T12:00:44.4000382+00:00",
"date_out_of_production_since": "2026-05-30T12:00:44.4000382+00:00",
"date_end_support": "2026-05-30T12:00:44.4000382+00:00",
"sales_organization_id": "508637fe-3171-4e72-8423-bff43f670d75",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "b9391057-ce78-4722-aedf-2d2988aab054",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c5cd6676-764c-4fba-977e-5e9550ded268",
"db_currency_id": "61ca0bb5-3b55-4f1d-8dc0-b4c36bdda195",
"db_language_id": "697fce95-4752-496c-93bb-c235d547f6ad",
"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-30T12:00:44.4000382+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-30T12:00:44.4000382+00:00"
},
"project_status_id": "9d198469-a934-4b36-8530-c83658701622",
"project_status_code": "sample string 10",
"project_status": {
"id": "e8995953-7f2d-4b63-9ec1-61452d4aecac",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "28c46514-cb5e-4e23-8697-411ea2e4b57a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b9391057-ce78-4722-aedf-2d2988aab054",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c5cd6676-764c-4fba-977e-5e9550ded268",
"db_currency_id": "61ca0bb5-3b55-4f1d-8dc0-b4c36bdda195",
"db_language_id": "697fce95-4752-496c-93bb-c235d547f6ad",
"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-30T12:00:44.4000382+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-30T12:00:44.4000382+00:00"
},
"company_id": "74089cb1-1f0c-4b2c-8e70-64a47428d43b",
"company_code": "sample string 12",
"db_address_id": "7cac90e4-c48c-4a57-a2ef-263525ad4be5",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "41b4b282-ca07-4969-8bde-1fcb8c6d4e1b",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "1a027ecc-2bec-4c12-9964-5f7522dc1e57",
"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-30T12:00:44.4000382+00:00",
"date_create": "2026-05-30T12:00:44.4000382+00:00",
"date_update": "2026-05-30T12:00:44.4000382+00:00",
"updated_by_user_id": "11890ee9-e2f9-4ad8-9d02-3cfd5bf9141e",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-30T12:00:44.4000382+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-30T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-30T12:00:44.4000382+00:00",
"date_last_job": "2026-05-30T12:00:44.4000382+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-30T12:00:44.4000382+00:00",
"modified_dateutc": "2026-05-30T12:00:44.4000382+00:00",
"is_mobile_installation": true
},
"job_type_id": "60df852d-beac-4efc-bf19-670f0ad1cf58",
"job_type_code": "sample string 7",
"job_type": {
"id": "4a17fa05-3251-4e77-871a-e66b42c401a5",
"name": "sample string 2",
"sales_organization_id": "eb9f4215-0f82-4ea4-82eb-13835fbc5d04",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-30T12:00:44.4000382+00:00",
"code": "sample string 7"
},
"job_priority_id": "28f9280a-e287-4691-8921-e03fd21e58d6",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "05cda4e3-de85-4365-b5ac-9594f8459b02",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "10e81455-6f73-4642-ba65-486077a70769",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b9391057-ce78-4722-aedf-2d2988aab054",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c5cd6676-764c-4fba-977e-5e9550ded268",
"db_currency_id": "61ca0bb5-3b55-4f1d-8dc0-b4c36bdda195",
"db_language_id": "697fce95-4752-496c-93bb-c235d547f6ad",
"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-30T12:00:44.4000382+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-30T12:00:44.4000382+00:00"
},
"job_status_id": "c967e440-519f-46ae-bbc6-83b91d102d1c",
"job_status_code": "sample string 11",
"db_address_id": "0a9d2fb8-1c93-4266-bdbe-6341c2e41711",
"contact_id": "a28ce2a0-4a0b-4906-ac1c-e63a204799eb",
"requested_by_company_id": "ea22a609-cd4c-4067-a66f-d75a5035d80d",
"requested_by_contact_id": "ebca06e6-9001-497f-9fc1-625bbe00d49c",
"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-30T12:00:44.4000382+00:00",
"due_date": "2026-05-30T12:00:44.4000382+00:00",
"date_create": "2026-05-30T12:00:44.4000382+00:00",
"date_update": "2026-05-30T12:00:44.4000382+00:00",
"date_closed": "2026-05-30T12:00:44.4000382+00:00",
"suggested_user_id": "1505f5dc-a1e9-4146-9b7a-fb5af8bb8697",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "97464202-8d6c-46b3-839c-96f26fe5830c",
"db_language_id": "df7171a2-3c5a-4e65-9680-1c8ebe13cde0",
"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-30T12:00:44.4000382+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "7372e21e-093b-4ee8-81db-ea62f2a7ad6f",
"sales_organization": {
"id": "b9391057-ce78-4722-aedf-2d2988aab054",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c5cd6676-764c-4fba-977e-5e9550ded268",
"db_currency_id": "61ca0bb5-3b55-4f1d-8dc0-b4c36bdda195",
"db_language_id": "697fce95-4752-496c-93bb-c235d547f6ad",
"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-30T12:00:44.4000382+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "65c70961-d636-4d83-ad2c-cbbd84ac813d",
"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": "1fc78899-1628-43c8-a34d-b49a6a987398",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-30T12:00:44.4000382+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "6f415604-60ab-4e69-a10e-db56b466948f"
},
"suggested_date_start": "2026-05-30T12:00:44.4000382+00:00",
"skill_id": "f5156b84-e3e5-47d2-8437-40516dec505d",
"skill_code": "sample string 32",
"skill": {
"id": "665c582f-6926-4320-aa24-c7a641fc9128",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "f49601db-4bb9-4cd6-94ca-e920ee5a9072",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b9391057-ce78-4722-aedf-2d2988aab054",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c5cd6676-764c-4fba-977e-5e9550ded268",
"db_currency_id": "61ca0bb5-3b55-4f1d-8dc0-b4c36bdda195",
"db_language_id": "697fce95-4752-496c-93bb-c235d547f6ad",
"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-30T12:00:44.4000382+00:00"
},
"modified_dateutc": "2026-05-30T12:00:44.4000382+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "d2817db8-e204-4b8a-89c5-99af7c9c0da2",
"date_reported_by_company": "2026-05-30T12:00:44.4000382+00:00",
"id2": 36,
"company_id": "9ceae31a-ef58-4e08-9021-67d82cae08de",
"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": "e01a5ace-918f-4869-8cb7-ed259cfc1e36",
"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-30T12:00:44.4000382+00:00"
},
"work_instruction_details_id": "453e234d-449f-4113-bf6c-0608e9ef1e47",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "3bda40c5-8514-4aa1-a093-1107ebfafed6",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "6ed6daf2-664d-402c-b92b-30624f6e564b",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-30T12:00:44.4000382+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": "b2788cee-f248-4654-b02b-5fdc0e79598d",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-30T12:00:44.4000382+00:00"
}