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": "59c00018-c55a-4c5b-a7c1-99d51dd6a025",
"jobs_id": "1010218d-7ba8-4fe4-b11f-fc05f491f6f1",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "3065675c-7856-4606-8312-b77b46bc666c",
"_parent_id": "20a066ab-adf8-4de4-a314-f89a7900bc36",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "1f205105-78d2-402c-972f-d90fa02d8e4a",
"project_reference_back_office": "sample string 5",
"project": {
"id": "a64be6d1-6918-4d68-97a1-1de57b6606b6",
"_parent_id": "1c2c71b8-9928-4816-b010-9a10aadff359",
"root_parent_id": "6b126102-87eb-4757-9000-cc014360072f",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "e05d5a50-cd9d-49a4-ad42-b4365faf225e",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "959bb5c7-8342-4235-be5a-7dce5f1a5dec",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c195b916-f052-4dfe-84ed-cba739b05ed7",
"_parent_code": "sample string 6",
"sales_organization_id": "b7be6751-863b-4db0-bb11-3f6d6dea7c7c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1ff1a2a0-300f-47f3-9df5-aa66f11b364b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0ee3d7bb-b56b-4c55-bd19-c7a9974abb6c",
"db_currency_id": "40776929-07e0-4869-86b9-fc204b58b3d6",
"db_language_id": "7ec280cb-dd6b-45d0-90db-0b8fa8d9cfd8",
"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-12T06:33:54.6406938+00:00"
},
"modified_dateutc": "2026-08-12T06:33:54.6406938+00:00"
},
"equipment_model_id": "af6d7a78-73c1-4b04-9129-bffe5d0641f8",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "e390da17-2eaa-4f88-85e3-456196829e2f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "f28be444-63cb-4048-be35-fb84e83b6b9f",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "4f1706d1-21f9-4680-88bd-72a845fd78c8",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "b782f5c1-2f12-42ee-b22a-5842854b6649",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1ff1a2a0-300f-47f3-9df5-aa66f11b364b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0ee3d7bb-b56b-4c55-bd19-c7a9974abb6c",
"db_currency_id": "40776929-07e0-4869-86b9-fc204b58b3d6",
"db_language_id": "7ec280cb-dd6b-45d0-90db-0b8fa8d9cfd8",
"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-12T06:33:54.6406938+00:00"
},
"modified_dateutc": "2026-08-12T06:33:54.6406938+00:00"
},
"equipment_family_id": "19e6f896-daf7-4b07-940a-df69277bbe77",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "959bb5c7-8342-4235-be5a-7dce5f1a5dec",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c195b916-f052-4dfe-84ed-cba739b05ed7",
"_parent_code": "sample string 6",
"sales_organization_id": "b7be6751-863b-4db0-bb11-3f6d6dea7c7c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1ff1a2a0-300f-47f3-9df5-aa66f11b364b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0ee3d7bb-b56b-4c55-bd19-c7a9974abb6c",
"db_currency_id": "40776929-07e0-4869-86b9-fc204b58b3d6",
"db_language_id": "7ec280cb-dd6b-45d0-90db-0b8fa8d9cfd8",
"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-12T06:33:54.6406938+00:00"
},
"modified_dateutc": "2026-08-12T06:33:54.6406938+00:00"
},
"date_in_production_since": "2026-08-12T06:33:54.6406938+00:00",
"date_out_of_production_since": "2026-08-12T06:33:54.6406938+00:00",
"date_end_support": "2026-08-12T06:33:54.6406938+00:00",
"sales_organization_id": "ad7a3838-695f-436c-96cc-643943437010",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "1ff1a2a0-300f-47f3-9df5-aa66f11b364b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0ee3d7bb-b56b-4c55-bd19-c7a9974abb6c",
"db_currency_id": "40776929-07e0-4869-86b9-fc204b58b3d6",
"db_language_id": "7ec280cb-dd6b-45d0-90db-0b8fa8d9cfd8",
"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-12T06:33:54.6406938+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-12T06:33:54.6406938+00:00"
},
"project_status_id": "f24261e5-d22f-46e1-a937-50d8630253e9",
"project_status_code": "sample string 10",
"project_status": {
"id": "18caf000-a5cb-4c69-b03f-c0263e725dee",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "2093f35d-7905-47e5-a48b-55101592bfe6",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1ff1a2a0-300f-47f3-9df5-aa66f11b364b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0ee3d7bb-b56b-4c55-bd19-c7a9974abb6c",
"db_currency_id": "40776929-07e0-4869-86b9-fc204b58b3d6",
"db_language_id": "7ec280cb-dd6b-45d0-90db-0b8fa8d9cfd8",
"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-12T06:33:54.6406938+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-12T06:33:54.6406938+00:00"
},
"company_id": "e33afca9-794d-4bd6-a098-39d471af22d6",
"company_code": "sample string 12",
"db_address_id": "95560418-b4f5-464f-8e88-22724f89ac7a",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "6961f982-3d3a-4745-b565-b35bb4aca551",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "a8ce13f0-3fe0-4f6e-b85c-b164ee71b604",
"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-12T06:33:54.6406938+00:00",
"date_create": "2026-08-12T06:33:54.6406938+00:00",
"date_update": "2026-08-12T06:33:54.6406938+00:00",
"updated_by_user_id": "32ae40a0-65b0-444a-b535-87098cba300c",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-12T06:33:54.6406938+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-12T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-12T06:33:54.6406938+00:00",
"date_last_job": "2026-08-12T06:33:54.6406938+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-12T06:33:54.6406938+00:00",
"modified_dateutc": "2026-08-12T06:33:54.6406938+00:00",
"is_mobile_installation": true
},
"job_type_id": "d5b1be43-e6f6-42fd-8e4c-2dc80f742699",
"job_type_code": "sample string 7",
"job_type": {
"id": "e4e43962-f9ba-460d-a964-c41ba1d2e752",
"name": "sample string 2",
"sales_organization_id": "86e0925d-7a81-4155-8902-87fdcaea8217",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-12T06:33:54.6406938+00:00",
"code": "sample string 7"
},
"job_priority_id": "fb4fe6a1-d595-41bc-8f96-cbc42c716a18",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "ee1b6bb2-025e-43fc-98cd-71f2126e1aca",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "a4d05a7b-a016-423c-ae3b-5371faec2679",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1ff1a2a0-300f-47f3-9df5-aa66f11b364b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0ee3d7bb-b56b-4c55-bd19-c7a9974abb6c",
"db_currency_id": "40776929-07e0-4869-86b9-fc204b58b3d6",
"db_language_id": "7ec280cb-dd6b-45d0-90db-0b8fa8d9cfd8",
"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-12T06:33:54.6406938+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-12T06:33:54.6406938+00:00"
},
"job_status_id": "49e601cf-18d4-4467-a63e-f5184f3e5cfc",
"job_status_code": "sample string 11",
"db_address_id": "4314b851-5669-480a-a6aa-4cd0097076c0",
"contact_id": "49bcc3c2-a76c-404e-a811-24c8aa2d24cb",
"requested_by_company_id": "3e052877-386d-42fe-9523-6161b14990ea",
"requested_by_contact_id": "b98b7fa5-19d5-4776-b9a8-c36346e41d24",
"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-12T06:33:54.6406938+00:00",
"due_date": "2026-08-12T06:33:54.6406938+00:00",
"date_create": "2026-08-12T06:33:54.6406938+00:00",
"date_update": "2026-08-12T06:33:54.6406938+00:00",
"date_closed": "2026-08-12T06:33:54.6406938+00:00",
"suggested_user_id": "23f596ab-04c7-410e-a335-998337e7033e",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "15e0336c-b1e0-448b-bc74-2e7993e31f86",
"db_language_id": "f18f96a3-35f5-466a-a3b8-985c995ae332",
"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-12T06:33:54.6406938+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "7176e4b5-5023-4481-ac90-8067b8a5af46",
"sales_organization": {
"id": "1ff1a2a0-300f-47f3-9df5-aa66f11b364b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0ee3d7bb-b56b-4c55-bd19-c7a9974abb6c",
"db_currency_id": "40776929-07e0-4869-86b9-fc204b58b3d6",
"db_language_id": "7ec280cb-dd6b-45d0-90db-0b8fa8d9cfd8",
"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-12T06:33:54.6406938+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "92ec6138-fd4a-4e61-a6f0-000a09df4547",
"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": "f96dc653-785e-4dde-b884-fa7bbd073d02",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-12T06:33:54.6406938+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "890fdf4e-bd7d-46e3-ba85-b426ac4ba94a"
},
"suggested_date_start": "2026-08-12T06:33:54.6406938+00:00",
"skill_id": "0e58a8a4-4e78-42e3-b8ff-a9e2098d5c21",
"skill_code": "sample string 32",
"skill": {
"id": "5f46a247-4d4b-4574-b9ab-4bfd6b581088",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "1cc6653c-f9ee-4fb9-a8b6-11e6d7a26260",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1ff1a2a0-300f-47f3-9df5-aa66f11b364b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0ee3d7bb-b56b-4c55-bd19-c7a9974abb6c",
"db_currency_id": "40776929-07e0-4869-86b9-fc204b58b3d6",
"db_language_id": "7ec280cb-dd6b-45d0-90db-0b8fa8d9cfd8",
"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-12T06:33:54.6406938+00:00"
},
"modified_dateutc": "2026-08-12T06:33:54.6406938+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "9e57a46f-8727-4fa1-8ed8-026e9eeccc8f",
"date_reported_by_company": "2026-08-12T06:33:54.6406938+00:00",
"id2": 36,
"company_id": "958e596e-0c77-47f6-828c-c8d6cb2ab832",
"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": "a3047c2f-efb5-4275-a61b-457e858558f2",
"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-12T06:33:54.6406938+00:00"
},
"work_instruction_details_id": "4407aa46-635b-4e3b-9b46-0c47583a38cf",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "291af959-0c27-4f93-8295-393b896b8088",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "c6d1997c-4872-4b26-98be-634456ed94b8",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-12T06:33:54.6406938+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": "1f241fb2-8a80-4832-a990-758a906ed449",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-12T06:33:54.6406938+00:00"
}