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": "e022d09b-b6e7-47dd-b771-172184282b2d",
"jobs_id": "4b46744b-d73f-484e-a8f1-1568c36a9a36",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "8e1d7fb6-990c-47a1-95d8-e8ee1440338a",
"_parent_id": "75150a8c-6cd4-498b-a5ac-a015351ee18f",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "685946eb-87b0-4b68-8337-8a7d90c79961",
"project_reference_back_office": "sample string 5",
"project": {
"id": "b4f7845b-9cf7-45b8-80de-167191d7784f",
"_parent_id": "1b2b6b4a-7a51-426b-9685-7d33c4bb11b6",
"root_parent_id": "c1d85d1e-d90e-4a88-91f9-07cd516721fa",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "9753fddd-1743-440a-80d9-5f8d3440d976",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "094c1474-6fd7-4087-91ff-0a136f45eb67",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2869a74d-a4cb-450b-ac6a-2f5fff8088b1",
"_parent_code": "sample string 6",
"sales_organization_id": "0b41dc40-1dbd-4c5b-86af-226313fd3da6",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a79f9c32-556f-4237-9b66-cc466813eebb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "66435a0a-189c-46c7-a285-b2735ed5308a",
"db_currency_id": "703301de-32eb-4294-b840-94700266e5e1",
"db_language_id": "6f642ebe-43a1-4402-afe8-7249495da741",
"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-03-13T06:40:57.6558719+00:00"
},
"modified_dateutc": "2026-03-13T06:40:57.6558719+00:00"
},
"equipment_model_id": "ab97af70-b37d-41fa-83eb-299a6ad8b621",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "0b8cd893-009b-4a45-8e65-7ab44c98bfe4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "59462488-d4b6-46e1-9b3f-7b2ac09a458f",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "254d0175-1fd6-4353-83a2-9b698dd99255",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "1293bf8e-9d92-4d65-b7ac-62506c8a8fa0",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a79f9c32-556f-4237-9b66-cc466813eebb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "66435a0a-189c-46c7-a285-b2735ed5308a",
"db_currency_id": "703301de-32eb-4294-b840-94700266e5e1",
"db_language_id": "6f642ebe-43a1-4402-afe8-7249495da741",
"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-03-13T06:40:57.6558719+00:00"
},
"modified_dateutc": "2026-03-13T06:40:57.6558719+00:00"
},
"equipment_family_id": "cc78d7c5-5254-45f5-b456-0bc73be2c9d5",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "094c1474-6fd7-4087-91ff-0a136f45eb67",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2869a74d-a4cb-450b-ac6a-2f5fff8088b1",
"_parent_code": "sample string 6",
"sales_organization_id": "0b41dc40-1dbd-4c5b-86af-226313fd3da6",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a79f9c32-556f-4237-9b66-cc466813eebb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "66435a0a-189c-46c7-a285-b2735ed5308a",
"db_currency_id": "703301de-32eb-4294-b840-94700266e5e1",
"db_language_id": "6f642ebe-43a1-4402-afe8-7249495da741",
"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-03-13T06:40:57.6558719+00:00"
},
"modified_dateutc": "2026-03-13T06:40:57.6558719+00:00"
},
"date_in_production_since": "2026-03-13T06:40:57.6558719+00:00",
"date_out_of_production_since": "2026-03-13T06:40:57.6558719+00:00",
"date_end_support": "2026-03-13T06:40:57.6558719+00:00",
"sales_organization_id": "f43dba12-b6e1-4833-ab1d-19faa618ce44",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "a79f9c32-556f-4237-9b66-cc466813eebb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "66435a0a-189c-46c7-a285-b2735ed5308a",
"db_currency_id": "703301de-32eb-4294-b840-94700266e5e1",
"db_language_id": "6f642ebe-43a1-4402-afe8-7249495da741",
"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-03-13T06:40:57.6558719+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-03-13T06:40:57.6558719+00:00"
},
"project_status_id": "2817a307-4323-41a6-bc1b-a94226e41f7f",
"project_status_code": "sample string 10",
"project_status": {
"id": "aaaddef8-a771-445a-8157-3335570a3c24",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "707dfa53-b925-4e64-ba24-34f57b4af289",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a79f9c32-556f-4237-9b66-cc466813eebb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "66435a0a-189c-46c7-a285-b2735ed5308a",
"db_currency_id": "703301de-32eb-4294-b840-94700266e5e1",
"db_language_id": "6f642ebe-43a1-4402-afe8-7249495da741",
"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-03-13T06:40:57.6558719+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-13T06:40:57.6558719+00:00"
},
"company_id": "7546e278-296c-4da9-ad72-f6e2c6164155",
"company_code": "sample string 12",
"db_address_id": "a8bfa9a0-7049-4040-a9f6-375c09a48483",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "8aabb45e-28a0-4427-9d04-1c12d81c49b8",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "5c5f7993-5547-438a-ae93-9849222c00fd",
"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-03-13T06:40:57.6558719+00:00",
"date_create": "2026-03-13T06:40:57.6558719+00:00",
"date_update": "2026-03-13T06:40:57.6558719+00:00",
"updated_by_user_id": "181d12d1-cfa5-481d-927c-abb3daea7ef7",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-03-13T06:40:57.6558719+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-03-13T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-03-13T06:40:57.6558719+00:00",
"date_last_job": "2026-03-13T06:40:57.6558719+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-03-13T06:40:57.6558719+00:00",
"modified_dateutc": "2026-03-13T06:40:57.6558719+00:00",
"is_mobile_installation": true
},
"job_type_id": "2f0be655-dfcb-4322-b360-1ec199996d0b",
"job_type_code": "sample string 7",
"job_type": {
"id": "5cc0852d-2ce9-4269-8811-88fc8dd3eb41",
"name": "sample string 2",
"sales_organization_id": "dc41ce4a-eb57-4002-a69e-e741f4521a81",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-03-13T06:40:57.6558719+00:00",
"code": "sample string 7"
},
"job_priority_id": "013dd5f9-8749-4680-9082-d95396758dc7",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "ab4f3428-c6ca-4728-a3f9-6181670a6b60",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "37c347fb-5b93-4dfc-9994-ceab8e8c9b78",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a79f9c32-556f-4237-9b66-cc466813eebb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "66435a0a-189c-46c7-a285-b2735ed5308a",
"db_currency_id": "703301de-32eb-4294-b840-94700266e5e1",
"db_language_id": "6f642ebe-43a1-4402-afe8-7249495da741",
"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-03-13T06:40:57.6558719+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-13T06:40:57.6558719+00:00"
},
"job_status_id": "98176f65-f1c5-4116-bb7d-2a439ba14f53",
"job_status_code": "sample string 11",
"db_address_id": "9f5c1532-6624-46f0-a9a4-28d6fc419162",
"contact_id": "fe6614b7-8c15-4fa3-87d1-5b906d4f2004",
"requested_by_company_id": "e4155d5d-f133-43b1-ad8d-ad1c1e5cba9e",
"requested_by_contact_id": "b0810578-6646-4210-afbe-823f62ac4c28",
"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-03-13T06:40:57.6558719+00:00",
"due_date": "2026-03-13T06:40:57.6558719+00:00",
"date_create": "2026-03-13T06:40:57.6558719+00:00",
"date_update": "2026-03-13T06:40:57.6558719+00:00",
"date_closed": "2026-03-13T06:40:57.6558719+00:00",
"suggested_user_id": "8c6a82f6-f157-4b36-9c30-45376f1ee49a",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "8f28b78c-0b81-4864-8dcb-755cd4684765",
"db_language_id": "937a9149-febc-41c6-9e3e-41931c1c4cf0",
"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-03-13T06:40:57.6558719+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "4a284722-8c16-41b1-930f-4157e0872f0d",
"sales_organization": {
"id": "a79f9c32-556f-4237-9b66-cc466813eebb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "66435a0a-189c-46c7-a285-b2735ed5308a",
"db_currency_id": "703301de-32eb-4294-b840-94700266e5e1",
"db_language_id": "6f642ebe-43a1-4402-afe8-7249495da741",
"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-03-13T06:40:57.6558719+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "6219fbe1-9276-4a24-922f-6c90c9eae9d7",
"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": "c7ea9a2c-ae22-44a6-bd80-ba3b0b5453eb",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-03-13T06:40:57.6558719+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "94922fa5-9433-4f34-8baf-0b2cc5d3ff6d"
},
"suggested_date_start": "2026-03-13T06:40:57.6558719+00:00",
"skill_id": "c5e0ed6a-74ad-4fd4-b688-4158fa7cf0c0",
"skill_code": "sample string 32",
"skill": {
"id": "7f6a9d93-ab74-49a8-8e51-94b29b7c9bf3",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "8d91ac65-b200-489c-b444-e62bd097f704",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a79f9c32-556f-4237-9b66-cc466813eebb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "66435a0a-189c-46c7-a285-b2735ed5308a",
"db_currency_id": "703301de-32eb-4294-b840-94700266e5e1",
"db_language_id": "6f642ebe-43a1-4402-afe8-7249495da741",
"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-03-13T06:40:57.6558719+00:00"
},
"modified_dateutc": "2026-03-13T06:40:57.6558719+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "264258d5-6712-41f4-9390-4ef99e4bb476",
"date_reported_by_company": "2026-03-13T06:40:57.6558719+00:00",
"id2": 36,
"company_id": "6838bc90-7252-436a-aabd-442a4b1ab0ed",
"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": "e58906e6-d43e-45fc-a3fd-60f4d37122a8",
"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-03-13T06:40:57.6558719+00:00"
},
"work_instruction_details_id": "5c54d459-6424-41d4-9cea-d4bd9948e830",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "88f064a8-42dc-45f2-ad1d-c836b680cd08",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "9cc7e633-9dd9-4a32-add4-b80f9ee92dc2",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-03-13T06:40:57.6558719+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": "078a6b94-b01f-45dc-b6dd-80b01a63237c",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-03-13T06:40:57.6558719+00:00"
}