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": "5f8be34f-6242-4615-8798-238a8a6a6dba",
"jobs_id": "579f5de0-c9b3-4033-91ea-4b35f356dc7c",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "b5e31dba-40b9-4865-9f62-199d481b32d0",
"_parent_id": "d71195ba-c8b2-4bf8-a9ca-e75f957782a1",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "877403ee-2716-4737-bf4e-8846b379089b",
"project_reference_back_office": "sample string 5",
"project": {
"id": "114b8213-b468-4411-87f1-d333a2995b3b",
"_parent_id": "9b7ade51-2365-4609-b87f-fd83e00fbce8",
"root_parent_id": "c54ec761-e45a-4cbf-b061-c53ebd99f0e9",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "c62037df-c9b5-46a0-b373-955590e46a18",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "3ab8741f-b5c8-4fa4-b2b1-b43dbdf1d019",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "58167e63-0f78-41ba-97d1-ab07a6dae97c",
"_parent_code": "sample string 6",
"sales_organization_id": "3322b2ed-fb08-4b6f-a03b-6f8c7dfc5a11",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b39236a9-e992-4e90-9595-959589f55f8b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e60c07b8-aee2-46dd-bb97-7220624e37dd",
"db_currency_id": "235858d7-fa29-45ba-8510-278307e80767",
"db_language_id": "25590587-daf3-4370-98a7-69928eb8d235",
"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-10-03T07:01:26.7742815+00:00"
},
"modified_dateutc": "2026-10-03T07:01:26.7742815+00:00"
},
"equipment_model_id": "270356d5-9423-4aa3-9dbb-4eb571f525ba",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "b79de25f-373a-4a50-b81c-17c6988b5d64",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "45ca58d7-7319-4675-9967-8557df328c3d",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "c3298c61-e138-449f-8758-79dd12f04ae0",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "bd545a7b-cd41-4ae2-bbb3-93317641b843",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b39236a9-e992-4e90-9595-959589f55f8b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e60c07b8-aee2-46dd-bb97-7220624e37dd",
"db_currency_id": "235858d7-fa29-45ba-8510-278307e80767",
"db_language_id": "25590587-daf3-4370-98a7-69928eb8d235",
"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-10-03T07:01:26.7742815+00:00"
},
"modified_dateutc": "2026-10-03T07:01:26.7742815+00:00"
},
"equipment_family_id": "3dc479cb-67e9-4e11-9e4b-65292fa059b0",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "3ab8741f-b5c8-4fa4-b2b1-b43dbdf1d019",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "58167e63-0f78-41ba-97d1-ab07a6dae97c",
"_parent_code": "sample string 6",
"sales_organization_id": "3322b2ed-fb08-4b6f-a03b-6f8c7dfc5a11",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b39236a9-e992-4e90-9595-959589f55f8b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e60c07b8-aee2-46dd-bb97-7220624e37dd",
"db_currency_id": "235858d7-fa29-45ba-8510-278307e80767",
"db_language_id": "25590587-daf3-4370-98a7-69928eb8d235",
"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-10-03T07:01:26.7742815+00:00"
},
"modified_dateutc": "2026-10-03T07:01:26.7742815+00:00"
},
"date_in_production_since": "2026-10-03T07:01:26.7742815+00:00",
"date_out_of_production_since": "2026-10-03T07:01:26.7742815+00:00",
"date_end_support": "2026-10-03T07:01:26.7742815+00:00",
"sales_organization_id": "9212ece4-3311-4e60-95dc-5413b1397a3a",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "b39236a9-e992-4e90-9595-959589f55f8b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e60c07b8-aee2-46dd-bb97-7220624e37dd",
"db_currency_id": "235858d7-fa29-45ba-8510-278307e80767",
"db_language_id": "25590587-daf3-4370-98a7-69928eb8d235",
"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-10-03T07:01:26.7742815+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-10-03T07:01:26.7742815+00:00"
},
"project_status_id": "27c14979-0e63-4b1a-ae85-968a8cbbdaac",
"project_status_code": "sample string 10",
"project_status": {
"id": "3eae5f49-4968-4bc7-ab72-0ac5e8532830",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "6fd7e5d8-bc5a-4fdf-b923-deaca9b1367e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b39236a9-e992-4e90-9595-959589f55f8b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e60c07b8-aee2-46dd-bb97-7220624e37dd",
"db_currency_id": "235858d7-fa29-45ba-8510-278307e80767",
"db_language_id": "25590587-daf3-4370-98a7-69928eb8d235",
"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-10-03T07:01:26.7742815+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-03T07:01:26.7742815+00:00"
},
"company_id": "18f1fc2d-ef11-41de-8bc9-835c6caf23e4",
"company_code": "sample string 12",
"db_address_id": "34f896de-52c7-4437-b296-f311288c2b6d",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "06d45646-5205-4a57-9356-f784e757fd61",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "8880c9a7-0be6-475f-b610-b87556464d6e",
"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-10-03T07:01:26.7742815+00:00",
"date_create": "2026-10-03T07:01:26.7742815+00:00",
"date_update": "2026-10-03T07:01:26.7742815+00:00",
"updated_by_user_id": "923973eb-4745-4974-95d9-d07b143bc052",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-03T07:01:26.7742815+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-10-03T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-03T07:01:26.7742815+00:00",
"date_last_job": "2026-10-03T07:01:26.7742815+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-03T07:01:26.7742815+00:00",
"modified_dateutc": "2026-10-03T07:01:26.7742815+00:00",
"is_mobile_installation": true
},
"job_type_id": "0876618c-9955-4ad0-89ee-dd06c1d274ac",
"job_type_code": "sample string 7",
"job_type": {
"id": "38025bc7-f589-420d-9912-627c6c69c7e7",
"name": "sample string 2",
"sales_organization_id": "56f2dc74-59e3-4717-99aa-af20bc77afb3",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-03T07:01:26.7742815+00:00",
"code": "sample string 7"
},
"job_priority_id": "477ea210-cefa-41f4-854c-5ae49b7b1bf2",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "33848ce4-6a75-4fa5-bc24-316748976720",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "2b43f233-43ba-4bb8-a724-550e6033368d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b39236a9-e992-4e90-9595-959589f55f8b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e60c07b8-aee2-46dd-bb97-7220624e37dd",
"db_currency_id": "235858d7-fa29-45ba-8510-278307e80767",
"db_language_id": "25590587-daf3-4370-98a7-69928eb8d235",
"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-10-03T07:01:26.7742815+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-03T07:01:26.7742815+00:00"
},
"job_status_id": "77bcf6d4-0877-432c-a766-70763b137a48",
"job_status_code": "sample string 11",
"db_address_id": "67f3e28b-416c-4d2e-ac6a-92f5bf315f5d",
"contact_id": "eac494e7-d216-4a45-b0f7-823f5c9bc6ed",
"requested_by_company_id": "a375b53d-da87-48cd-889d-da0197822d2c",
"requested_by_contact_id": "66cae970-11a4-4c67-a626-108fd1eee596",
"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-10-03T07:01:26.7742815+00:00",
"due_date": "2026-10-03T07:01:26.7742815+00:00",
"date_create": "2026-10-03T07:01:26.7742815+00:00",
"date_update": "2026-10-03T07:01:26.7742815+00:00",
"date_closed": "2026-10-03T07:01:26.7742815+00:00",
"suggested_user_id": "30f87819-0fff-4867-86db-84dad72cbeb0",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "23e1e399-3efb-452b-a0aa-b7c7a505071d",
"db_language_id": "d7d1e7e1-f883-4eaf-8e99-50177f0b1898",
"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-10-03T07:01:26.7742815+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "d92a9b78-a07a-43d2-9eaa-b071ed2476ab",
"sales_organization": {
"id": "b39236a9-e992-4e90-9595-959589f55f8b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e60c07b8-aee2-46dd-bb97-7220624e37dd",
"db_currency_id": "235858d7-fa29-45ba-8510-278307e80767",
"db_language_id": "25590587-daf3-4370-98a7-69928eb8d235",
"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-10-03T07:01:26.7742815+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "d61c6752-421f-4a9e-bd5d-4a6dd4c4275e",
"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": "3cc7c40f-b1f4-42d7-af04-dfdf932775ac",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-03T07:01:26.7742815+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "0fb98c91-74ee-4223-96cf-a82ac97f833c"
},
"suggested_date_start": "2026-10-03T07:01:26.7742815+00:00",
"skill_id": "9536f316-cf10-45ad-af69-a5211e4918dc",
"skill_code": "sample string 32",
"skill": {
"id": "67b3b440-fce0-4d12-bd70-e43faa9ed452",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "e1555261-c506-4252-ad9e-99ba7a40902c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b39236a9-e992-4e90-9595-959589f55f8b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e60c07b8-aee2-46dd-bb97-7220624e37dd",
"db_currency_id": "235858d7-fa29-45ba-8510-278307e80767",
"db_language_id": "25590587-daf3-4370-98a7-69928eb8d235",
"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-10-03T07:01:26.7742815+00:00"
},
"modified_dateutc": "2026-10-03T07:01:26.7742815+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "0ae4598e-d14a-4757-8aba-9f503e60d8c7",
"date_reported_by_company": "2026-10-03T07:01:26.7742815+00:00",
"id2": 36,
"company_id": "7c123207-add8-4fe3-9650-0fd34c5b6f55",
"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": "c2a5e7a8-23e3-48a9-b783-b78fc69e1af1",
"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-10-03T07:01:26.7742815+00:00"
},
"work_instruction_details_id": "f6a5f6f1-d285-42fe-adc9-1f207dcf5655",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "498f588b-8877-4d77-a5be-cbb97192b232",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "0fcdd170-45ec-43af-9876-7f136925e223",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-03T07:01:26.7742815+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": "44b3bec3-271e-4567-87e6-0853e9bd5eb9",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-03T07:01:26.7742815+00:00"
}