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": "c5420886-93c8-42cd-a724-a695dd98bbc6",
"jobs_id": "22a3b540-1630-4175-807c-588372960a0c",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "fde771fb-14a9-4790-bcd2-38ef6b695a52",
"_parent_id": "81c6c260-7836-42e6-98b6-eb816c36d30b",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "3ae9fe1e-3d74-4f0f-913c-bfb9a0a78361",
"project_reference_back_office": "sample string 5",
"project": {
"id": "cfa037b0-edc3-4968-928f-6ed30d05956a",
"_parent_id": "75743df4-be28-47cc-8863-a58627d076bc",
"root_parent_id": "c3a23723-979c-4682-9ea0-2589b8677435",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "d1b90a8a-3282-480f-8ddf-d4efb94b0308",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "58b6759d-fb1b-4994-953d-9df32a537874",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7f05a66d-103e-46ab-b270-78eddc44d295",
"_parent_code": "sample string 6",
"sales_organization_id": "f46de187-5421-43af-9546-59d02665ee73",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "95234546-0fcd-4981-ad6f-6a39f34a781e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "71ef92ae-232b-4bff-98e8-cb5cf8c6bcc1",
"db_currency_id": "060ba502-7d83-4adb-bf1d-7ffc6b796bbc",
"db_language_id": "41306089-5dde-48f8-ba3b-1671d0e1f5b8",
"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-08-15T08:20:28.2011679+00:00"
},
"modified_dateutc": "2026-08-15T08:20:28.2011679+00:00"
},
"equipment_model_id": "5bea66ee-6e49-417c-97c8-1219c9985079",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "c7db2268-d436-44e5-b803-f7cb65b4898f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "d2a15e80-2470-4862-85d0-8cfb3ded286e",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "3d94535c-87f7-4ceb-bb13-a3e4da96bdac",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "3982493c-273f-44f3-8a6b-0d43c215da89",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "95234546-0fcd-4981-ad6f-6a39f34a781e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "71ef92ae-232b-4bff-98e8-cb5cf8c6bcc1",
"db_currency_id": "060ba502-7d83-4adb-bf1d-7ffc6b796bbc",
"db_language_id": "41306089-5dde-48f8-ba3b-1671d0e1f5b8",
"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-08-15T08:20:28.2011679+00:00"
},
"modified_dateutc": "2026-08-15T08:20:28.2011679+00:00"
},
"equipment_family_id": "54291a5e-cb52-4baa-a923-9d2110d989fd",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "58b6759d-fb1b-4994-953d-9df32a537874",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7f05a66d-103e-46ab-b270-78eddc44d295",
"_parent_code": "sample string 6",
"sales_organization_id": "f46de187-5421-43af-9546-59d02665ee73",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "95234546-0fcd-4981-ad6f-6a39f34a781e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "71ef92ae-232b-4bff-98e8-cb5cf8c6bcc1",
"db_currency_id": "060ba502-7d83-4adb-bf1d-7ffc6b796bbc",
"db_language_id": "41306089-5dde-48f8-ba3b-1671d0e1f5b8",
"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-08-15T08:20:28.2011679+00:00"
},
"modified_dateutc": "2026-08-15T08:20:28.2011679+00:00"
},
"date_in_production_since": "2026-08-15T08:20:28.2011679+00:00",
"date_out_of_production_since": "2026-08-15T08:20:28.2011679+00:00",
"date_end_support": "2026-08-15T08:20:28.2011679+00:00",
"sales_organization_id": "1d216316-dfba-448e-8a7b-75b778e68464",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "95234546-0fcd-4981-ad6f-6a39f34a781e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "71ef92ae-232b-4bff-98e8-cb5cf8c6bcc1",
"db_currency_id": "060ba502-7d83-4adb-bf1d-7ffc6b796bbc",
"db_language_id": "41306089-5dde-48f8-ba3b-1671d0e1f5b8",
"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-08-15T08:20:28.2011679+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-08-15T08:20:28.2011679+00:00"
},
"project_status_id": "92e20033-4d7b-4282-9631-600aceed3f10",
"project_status_code": "sample string 10",
"project_status": {
"id": "7b3daabf-3832-4cec-a977-d3847b5e5f2f",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "1a3886d5-8a81-4336-bdd9-74c1e39b303f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "95234546-0fcd-4981-ad6f-6a39f34a781e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "71ef92ae-232b-4bff-98e8-cb5cf8c6bcc1",
"db_currency_id": "060ba502-7d83-4adb-bf1d-7ffc6b796bbc",
"db_language_id": "41306089-5dde-48f8-ba3b-1671d0e1f5b8",
"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-08-15T08:20:28.2011679+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-15T08:20:28.2011679+00:00"
},
"company_id": "64b829b3-d92c-4bbd-a92a-d43edd79fe76",
"company_code": "sample string 12",
"db_address_id": "21d56c9d-1edf-42f7-8a21-a7bc066a8429",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "1f9da987-bfc1-4fc9-9aa1-0505b25c292c",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "e46c1c44-bade-4834-8023-a5889c391586",
"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-08-15T08:20:28.2011679+00:00",
"date_create": "2026-08-15T08:20:28.2011679+00:00",
"date_update": "2026-08-15T08:20:28.2011679+00:00",
"updated_by_user_id": "7e69516b-ead9-4209-9190-af9a052fd11e",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-15T08:20:28.2011679+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-08-15T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-15T08:20:28.2011679+00:00",
"date_last_job": "2026-08-15T08:20:28.2011679+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-15T08:20:28.2011679+00:00",
"modified_dateutc": "2026-08-15T08:20:28.2011679+00:00",
"is_mobile_installation": true
},
"job_type_id": "76cd4fa2-580f-42b3-9e2e-92e828410c5d",
"job_type_code": "sample string 7",
"job_type": {
"id": "0463b31f-c3f9-4c94-9aea-7194f3ec44df",
"name": "sample string 2",
"sales_organization_id": "ce349c56-66ed-4194-badd-1c05223563cb",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-15T08:20:28.2011679+00:00",
"code": "sample string 7"
},
"job_priority_id": "4e98e4d3-a4fe-474a-9419-3a0d0b513201",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "7523b93f-63a5-4169-8cff-29f8044b5b80",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "0169c39a-81b3-403b-b7d6-30f76a509919",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "95234546-0fcd-4981-ad6f-6a39f34a781e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "71ef92ae-232b-4bff-98e8-cb5cf8c6bcc1",
"db_currency_id": "060ba502-7d83-4adb-bf1d-7ffc6b796bbc",
"db_language_id": "41306089-5dde-48f8-ba3b-1671d0e1f5b8",
"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-08-15T08:20:28.2011679+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-15T08:20:28.2011679+00:00"
},
"job_status_id": "c254ccb4-725e-4776-b0af-ef16273b4375",
"job_status_code": "sample string 11",
"db_address_id": "ed67a770-c2e2-464c-8a0b-e534d28e1d6a",
"contact_id": "7f5caab9-43ff-4959-b507-0b3e28f8d754",
"requested_by_company_id": "cd97781b-9420-408d-ac50-ecb93b4261a5",
"requested_by_contact_id": "0fb1d5e5-97f6-4856-88c3-4fc97feb7d98",
"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-08-15T08:20:28.2011679+00:00",
"due_date": "2026-08-15T08:20:28.2011679+00:00",
"date_create": "2026-08-15T08:20:28.2011679+00:00",
"date_update": "2026-08-15T08:20:28.2011679+00:00",
"date_closed": "2026-08-15T08:20:28.2011679+00:00",
"suggested_user_id": "5b98a66f-0386-4687-a94e-4fe9a7449223",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "725a88cb-588f-40ed-b32b-4f926822a278",
"db_language_id": "08e7889f-1ec5-493b-a07b-c4b9f811929b",
"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-08-15T08:20:28.2011679+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "2674dc2b-eb3c-47dc-85d2-d175256dc4ba",
"sales_organization": {
"id": "95234546-0fcd-4981-ad6f-6a39f34a781e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "71ef92ae-232b-4bff-98e8-cb5cf8c6bcc1",
"db_currency_id": "060ba502-7d83-4adb-bf1d-7ffc6b796bbc",
"db_language_id": "41306089-5dde-48f8-ba3b-1671d0e1f5b8",
"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-08-15T08:20:28.2011679+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "26930c16-d8ef-46a7-9065-a09c4633ef73",
"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": "e61cb380-7f52-495b-80e8-269fbc71e372",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-15T08:20:28.2011679+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "be1eb7e1-f0f8-40c7-99d4-4c6329e0770e"
},
"suggested_date_start": "2026-08-15T08:20:28.2011679+00:00",
"skill_id": "0d86a536-c23c-490f-8f32-ee3c5fefa471",
"skill_code": "sample string 32",
"skill": {
"id": "3649ee56-cde8-4c7a-a4df-649aecb8c8b1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "0aa7f87a-68dd-46d0-a971-fbe2956daebd",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "95234546-0fcd-4981-ad6f-6a39f34a781e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "71ef92ae-232b-4bff-98e8-cb5cf8c6bcc1",
"db_currency_id": "060ba502-7d83-4adb-bf1d-7ffc6b796bbc",
"db_language_id": "41306089-5dde-48f8-ba3b-1671d0e1f5b8",
"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-08-15T08:20:28.2011679+00:00"
},
"modified_dateutc": "2026-08-15T08:20:28.2011679+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "03af4dc7-0350-4ec0-a5fb-3da705a5f435",
"date_reported_by_company": "2026-08-15T08:20:28.2011679+00:00",
"id2": 36,
"company_id": "1b62398d-0b46-4a91-bfb2-2df85de97eb1",
"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": "8ee3e6c9-9c6b-44d4-bdba-5e521c66fb02",
"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-08-15T08:20:28.2011679+00:00"
},
"work_instruction_details_id": "46c3c5f2-649c-47da-a8bf-ee0584fb31c5",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "9c38f035-b28f-4f9f-a30d-d61ea27b4ad3",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "0a111ad0-d325-49d6-a096-4b0e219ce81c",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-15T08:20:28.2011679+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": "8bb1e1d8-f8bc-4771-aa69-1f525655e48b",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-15T08:20:28.2011679+00:00"
}