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": "5857962f-a131-4957-a44a-4f21c9e01263",
"jobs_id": "bf629460-5759-44da-a0f5-43b46a20f5ce",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "c9843ea2-f46a-46a9-a0ae-a4a055210141",
"_parent_id": "b203374d-76cb-40e9-9e56-432fd4b64955",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "696eb802-8efe-4a6c-a7cc-4c949195eea7",
"project_reference_back_office": "sample string 5",
"project": {
"id": "d848a2ff-0773-4e0b-bc3e-1a4ae86a4d50",
"_parent_id": "1bc99a27-8425-42d0-a336-72b2a404e90b",
"root_parent_id": "bc390f3b-8ed6-4f0e-b3ca-1319c5c7908b",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "617f19ba-3e0e-4cb4-aaf7-074b447a5648",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "9a5ee586-ed3f-4dae-887e-7213315546d6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "fb3cebfa-cce3-47d2-b5ca-1fe79c3ee05e",
"_parent_code": "sample string 6",
"sales_organization_id": "1fda4253-8d8f-43d0-9052-c3f6264b0342",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b57d201f-555f-4a11-8661-9e938387c985",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "120e30dc-4d96-4c6e-8124-5a8b001c88a2",
"db_currency_id": "3b7c7dcf-fcf4-45f9-984d-5b33193e4098",
"db_language_id": "12ed9de6-b1f5-4318-ac98-0694b3538169",
"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-07-25T00:53:06.5579487+00:00"
},
"modified_dateutc": "2026-07-25T00:53:06.5579487+00:00"
},
"equipment_model_id": "449190de-08b8-4679-b154-347ee902d690",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "7f2ffbf6-b207-4e95-a948-a328e432aee3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "30c7d47e-fdb8-4a49-a9e2-d9978f384723",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "c3a6ff30-66d2-4833-a2d1-77fbf141034e",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "06b08792-1a78-42f5-ad2b-289a1818c741",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b57d201f-555f-4a11-8661-9e938387c985",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "120e30dc-4d96-4c6e-8124-5a8b001c88a2",
"db_currency_id": "3b7c7dcf-fcf4-45f9-984d-5b33193e4098",
"db_language_id": "12ed9de6-b1f5-4318-ac98-0694b3538169",
"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-07-25T00:53:06.5579487+00:00"
},
"modified_dateutc": "2026-07-25T00:53:06.5579487+00:00"
},
"equipment_family_id": "a0fb149e-9cc5-449c-9797-fbe689a81a85",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "9a5ee586-ed3f-4dae-887e-7213315546d6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "fb3cebfa-cce3-47d2-b5ca-1fe79c3ee05e",
"_parent_code": "sample string 6",
"sales_organization_id": "1fda4253-8d8f-43d0-9052-c3f6264b0342",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b57d201f-555f-4a11-8661-9e938387c985",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "120e30dc-4d96-4c6e-8124-5a8b001c88a2",
"db_currency_id": "3b7c7dcf-fcf4-45f9-984d-5b33193e4098",
"db_language_id": "12ed9de6-b1f5-4318-ac98-0694b3538169",
"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-07-25T00:53:06.5579487+00:00"
},
"modified_dateutc": "2026-07-25T00:53:06.5579487+00:00"
},
"date_in_production_since": "2026-07-25T00:53:06.5579487+00:00",
"date_out_of_production_since": "2026-07-25T00:53:06.5579487+00:00",
"date_end_support": "2026-07-25T00:53:06.5579487+00:00",
"sales_organization_id": "b00ead8f-503a-4c02-852b-e5cf79b0077c",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "b57d201f-555f-4a11-8661-9e938387c985",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "120e30dc-4d96-4c6e-8124-5a8b001c88a2",
"db_currency_id": "3b7c7dcf-fcf4-45f9-984d-5b33193e4098",
"db_language_id": "12ed9de6-b1f5-4318-ac98-0694b3538169",
"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-07-25T00:53:06.5579487+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-07-25T00:53:06.5579487+00:00"
},
"project_status_id": "81c0a179-dc47-4d99-9dd6-afcb3ca771f5",
"project_status_code": "sample string 10",
"project_status": {
"id": "9a36815c-4655-4bd5-a6b6-41c2c3feba89",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "cdf38145-e84c-4b0c-ac42-fde8953985ac",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b57d201f-555f-4a11-8661-9e938387c985",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "120e30dc-4d96-4c6e-8124-5a8b001c88a2",
"db_currency_id": "3b7c7dcf-fcf4-45f9-984d-5b33193e4098",
"db_language_id": "12ed9de6-b1f5-4318-ac98-0694b3538169",
"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-07-25T00:53:06.5579487+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-25T00:53:06.5579487+00:00"
},
"company_id": "c96ac3a1-f6e5-4d8e-9fe8-d4aaeca319af",
"company_code": "sample string 12",
"db_address_id": "fdd97077-80f3-4939-a3da-b907bd7e4d94",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "b4d7eccc-d2aa-48b4-8961-07b454e7e867",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "d25c2f85-f7b3-46f4-857c-e47f303f330b",
"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-07-25T00:53:06.5579487+00:00",
"date_create": "2026-07-25T00:53:06.5579487+00:00",
"date_update": "2026-07-25T00:53:06.5579487+00:00",
"updated_by_user_id": "30efb780-18a5-4558-9d28-a31e49cbc30a",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-25T00:53:06.5579487+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-07-25T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-25T00:53:06.5579487+00:00",
"date_last_job": "2026-07-25T00:53:06.5579487+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-25T00:53:06.5579487+00:00",
"modified_dateutc": "2026-07-25T00:53:06.5579487+00:00",
"is_mobile_installation": true
},
"job_type_id": "81dd61bf-247f-4a8d-8491-7d8c3222d8c3",
"job_type_code": "sample string 7",
"job_type": {
"id": "1d52c30d-51ef-45b6-b70c-a52a24ace17a",
"name": "sample string 2",
"sales_organization_id": "946f0e6d-5626-4d4f-bc3d-9a645e2edefb",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-25T00:53:06.5579487+00:00",
"code": "sample string 7"
},
"job_priority_id": "e979ffd9-5328-4e69-89b0-af01f46c5268",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "f7b7d25f-2264-4143-80b9-22eb41a4279e",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "6ac6d286-5eb1-4461-83a8-b700c2331160",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b57d201f-555f-4a11-8661-9e938387c985",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "120e30dc-4d96-4c6e-8124-5a8b001c88a2",
"db_currency_id": "3b7c7dcf-fcf4-45f9-984d-5b33193e4098",
"db_language_id": "12ed9de6-b1f5-4318-ac98-0694b3538169",
"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-07-25T00:53:06.5579487+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-25T00:53:06.5579487+00:00"
},
"job_status_id": "fbfd32a6-6ad4-438c-b1ff-8113b6981495",
"job_status_code": "sample string 11",
"db_address_id": "f8e7e57d-a73c-41b1-ade4-5bfa9f8756fc",
"contact_id": "1bad4d3e-1966-461b-83d5-3ee12ea400a2",
"requested_by_company_id": "bf1b01b4-ce1e-4412-8865-6ef3d368667c",
"requested_by_contact_id": "88a18af0-59d2-4339-85ea-6cf3a80be049",
"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-07-25T00:53:06.5579487+00:00",
"due_date": "2026-07-25T00:53:06.5579487+00:00",
"date_create": "2026-07-25T00:53:06.5579487+00:00",
"date_update": "2026-07-25T00:53:06.5579487+00:00",
"date_closed": "2026-07-25T00:53:06.5579487+00:00",
"suggested_user_id": "48aa10cd-06a8-4a67-a829-2004f75ee425",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "80bab2cb-db12-45f1-ae57-56cb9fcbdc1a",
"db_language_id": "cec86de4-49dc-4cbd-835b-48d7c1dc7ae1",
"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-07-25T00:53:06.5579487+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "26c0bdd2-f0d7-407c-9806-a710dda69f99",
"sales_organization": {
"id": "b57d201f-555f-4a11-8661-9e938387c985",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "120e30dc-4d96-4c6e-8124-5a8b001c88a2",
"db_currency_id": "3b7c7dcf-fcf4-45f9-984d-5b33193e4098",
"db_language_id": "12ed9de6-b1f5-4318-ac98-0694b3538169",
"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-07-25T00:53:06.5579487+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "66a82865-c464-4936-9408-1d1facda0bf5",
"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": "2e458e2c-7e9b-4b71-981f-4da3078655bf",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-25T00:53:06.5579487+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "21c55ea5-04fc-4697-b2d4-f7c99995c2aa"
},
"suggested_date_start": "2026-07-25T00:53:06.5579487+00:00",
"skill_id": "839593b8-2db8-4d30-8c67-1026c1231c05",
"skill_code": "sample string 32",
"skill": {
"id": "a21828aa-9378-421c-a91e-0dcd00b2c975",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "f66083d1-6678-4a98-a43f-79507c94a07d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b57d201f-555f-4a11-8661-9e938387c985",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "120e30dc-4d96-4c6e-8124-5a8b001c88a2",
"db_currency_id": "3b7c7dcf-fcf4-45f9-984d-5b33193e4098",
"db_language_id": "12ed9de6-b1f5-4318-ac98-0694b3538169",
"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-07-25T00:53:06.5579487+00:00"
},
"modified_dateutc": "2026-07-25T00:53:06.5579487+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "e08eedfa-6bc1-4343-9733-474c8e32c9ce",
"date_reported_by_company": "2026-07-25T00:53:06.5579487+00:00",
"id2": 36,
"company_id": "0a140276-a507-4ad4-85ec-8634ef6a3f0e",
"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": "8200dd64-7e38-4ac8-ad04-c6545a34f9cd",
"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-07-25T00:53:06.5579487+00:00"
},
"work_instruction_details_id": "1e577c99-f107-417f-ba91-250f72134b4a",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "e3536aa7-17e2-4ced-9936-710fa8980006",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "b5db3af5-8d33-4d5d-b8d9-60c092e90e28",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-25T00:53:06.5579487+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": "14521b12-361a-49ee-8109-b468ce00752a",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-25T00:53:06.5579487+00:00"
}