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": "83bb96dc-d071-40b7-be3b-cd33cf5f387e",
"jobs_id": "6da49961-bca4-4529-b485-256f631eaaf3",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "fadd3d07-7a63-41c6-8c5b-9e4132baed6e",
"_parent_id": "d7ba0b67-3f8b-4d70-96df-10821c510227",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "a5cd76a6-9891-450e-a34e-8ebc6e0d50aa",
"project_reference_back_office": "sample string 5",
"project": {
"id": "59746c75-b71b-454e-bb3d-41aecc7fa0a5",
"_parent_id": "694021a1-4f3a-4128-84fb-6781c9359b50",
"root_parent_id": "e6271259-6942-4a2b-8f0e-5f5163cf3c19",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "57aae52b-e1e5-4b8d-8ac5-f0a666d9f979",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "68f1a4ba-e4d0-410a-a269-92e92e485ac3",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "72d08a19-a1f5-4381-9c46-cca6f2a9336c",
"_parent_code": "sample string 6",
"sales_organization_id": "54b84cd1-3f05-4d40-996f-a5bcc111ccd3",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "2de24732-78fd-47da-bd3c-9ff268018cd8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1b13cd91-6e7f-42ae-a43f-a0f516ce7b96",
"db_currency_id": "d48c04ed-2ddb-43fe-86a9-a1ea8899ac6f",
"db_language_id": "971ea924-2437-49a6-b453-78c0c7e203bb",
"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-19T01:44:34.9801564+00:00"
},
"modified_dateutc": "2026-03-19T01:44:34.9801564+00:00"
},
"equipment_model_id": "2c647135-bb21-4e97-b25a-37c4cdaee091",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "120e1ae7-8e00-4b66-ba7c-c50540ab5dd0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "d870cd0c-8bf5-4466-9ff8-ed2e51dca15f",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "1c4b590d-f049-43c2-8b45-51e21fb2da4d",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "7b95c85b-fb3f-46cc-a445-3d0264ee8d6e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2de24732-78fd-47da-bd3c-9ff268018cd8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1b13cd91-6e7f-42ae-a43f-a0f516ce7b96",
"db_currency_id": "d48c04ed-2ddb-43fe-86a9-a1ea8899ac6f",
"db_language_id": "971ea924-2437-49a6-b453-78c0c7e203bb",
"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-19T01:44:34.9801564+00:00"
},
"modified_dateutc": "2026-03-19T01:44:34.9801564+00:00"
},
"equipment_family_id": "e25c7910-d3cd-4340-9832-20defb062be1",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "68f1a4ba-e4d0-410a-a269-92e92e485ac3",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "72d08a19-a1f5-4381-9c46-cca6f2a9336c",
"_parent_code": "sample string 6",
"sales_organization_id": "54b84cd1-3f05-4d40-996f-a5bcc111ccd3",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "2de24732-78fd-47da-bd3c-9ff268018cd8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1b13cd91-6e7f-42ae-a43f-a0f516ce7b96",
"db_currency_id": "d48c04ed-2ddb-43fe-86a9-a1ea8899ac6f",
"db_language_id": "971ea924-2437-49a6-b453-78c0c7e203bb",
"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-19T01:44:34.9801564+00:00"
},
"modified_dateutc": "2026-03-19T01:44:34.9801564+00:00"
},
"date_in_production_since": "2026-03-19T01:44:34.9801564+00:00",
"date_out_of_production_since": "2026-03-19T01:44:34.9801564+00:00",
"date_end_support": "2026-03-19T01:44:34.9801564+00:00",
"sales_organization_id": "c64c0ea3-50d8-48d3-9b36-0f345807d84b",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "2de24732-78fd-47da-bd3c-9ff268018cd8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1b13cd91-6e7f-42ae-a43f-a0f516ce7b96",
"db_currency_id": "d48c04ed-2ddb-43fe-86a9-a1ea8899ac6f",
"db_language_id": "971ea924-2437-49a6-b453-78c0c7e203bb",
"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-19T01:44:34.9801564+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-19T01:44:34.9801564+00:00"
},
"project_status_id": "68e579fc-cb99-4998-b1f7-6b1f969dcd5f",
"project_status_code": "sample string 10",
"project_status": {
"id": "f9f72c05-7d7d-4f7a-9527-0ac614d4997b",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "a1159732-12d1-44a5-a784-7bb06647121f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2de24732-78fd-47da-bd3c-9ff268018cd8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1b13cd91-6e7f-42ae-a43f-a0f516ce7b96",
"db_currency_id": "d48c04ed-2ddb-43fe-86a9-a1ea8899ac6f",
"db_language_id": "971ea924-2437-49a6-b453-78c0c7e203bb",
"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-19T01:44:34.9801564+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-19T01:44:34.9801564+00:00"
},
"company_id": "20171062-4e2c-4b21-9022-7a8bac3f1b0d",
"company_code": "sample string 12",
"db_address_id": "79f928fb-1572-478d-a677-ab64fc566389",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "c755be25-af8c-4b4d-b56b-b90a67f6bfe7",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "a9a63c6d-30b1-49d8-a1e3-8ed2e78e5e54",
"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-19T01:44:34.9801564+00:00",
"date_create": "2026-03-19T01:44:34.9801564+00:00",
"date_update": "2026-03-19T01:44:34.9801564+00:00",
"updated_by_user_id": "b81de564-6de2-45b1-baca-8df125b99a7e",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-03-19T01:44:34.9801564+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-19T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-03-19T01:44:34.9801564+00:00",
"date_last_job": "2026-03-19T01:44:34.9801564+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-03-19T01:44:34.9801564+00:00",
"modified_dateutc": "2026-03-19T01:44:34.9801564+00:00",
"is_mobile_installation": true
},
"job_type_id": "1679f11c-8d97-44b5-98ef-79038f942b85",
"job_type_code": "sample string 7",
"job_type": {
"id": "41273602-4f95-4074-a618-d41440075480",
"name": "sample string 2",
"sales_organization_id": "f0b17fe6-9c60-4d8e-9d50-cf50a139d6d8",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-03-19T01:44:34.9801564+00:00",
"code": "sample string 7"
},
"job_priority_id": "914cb48f-b127-40d1-9e86-3d4d2a08cfbe",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "7c90ba26-28bc-458e-9d0e-2fc60386cb3a",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "85cf7b93-7f95-435a-85dd-215ea7d2f684",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2de24732-78fd-47da-bd3c-9ff268018cd8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1b13cd91-6e7f-42ae-a43f-a0f516ce7b96",
"db_currency_id": "d48c04ed-2ddb-43fe-86a9-a1ea8899ac6f",
"db_language_id": "971ea924-2437-49a6-b453-78c0c7e203bb",
"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-19T01:44:34.9801564+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-19T01:44:34.9801564+00:00"
},
"job_status_id": "21291ee5-e01f-496d-ae3c-b85d74ffc817",
"job_status_code": "sample string 11",
"db_address_id": "ce40fddb-f5e0-42f5-a8ea-064c53982b57",
"contact_id": "a8cb4126-8077-4ed4-b6e9-eba144edbb05",
"requested_by_company_id": "0ae01c01-9524-4c62-92fd-0005041339ef",
"requested_by_contact_id": "942227b2-4000-4d4e-8828-df08c55e137f",
"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-19T01:44:34.9801564+00:00",
"due_date": "2026-03-19T01:44:34.9801564+00:00",
"date_create": "2026-03-19T01:44:34.9801564+00:00",
"date_update": "2026-03-19T01:44:34.9801564+00:00",
"date_closed": "2026-03-19T01:44:34.9801564+00:00",
"suggested_user_id": "e0429fa9-0d9e-4266-a3dd-2d62aa6029eb",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "c1ad9322-a4eb-4c55-a86f-9d72e9512ee9",
"db_language_id": "f8e96ecb-820c-4f99-85bc-2c4a0a3928b2",
"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-19T01:44:34.9801564+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "2addf27f-5455-4e20-8df9-e3d75720c27e",
"sales_organization": {
"id": "2de24732-78fd-47da-bd3c-9ff268018cd8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1b13cd91-6e7f-42ae-a43f-a0f516ce7b96",
"db_currency_id": "d48c04ed-2ddb-43fe-86a9-a1ea8899ac6f",
"db_language_id": "971ea924-2437-49a6-b453-78c0c7e203bb",
"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-19T01:44:34.9801564+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "4e96384e-5596-43b2-ae2e-1a3bc3a5e110",
"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": "2ae3dead-bb1c-43d3-8161-467e0fa39006",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-03-19T01:44:34.9801564+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "a267f907-af10-4539-8d06-f003e5626c40"
},
"suggested_date_start": "2026-03-19T01:44:34.9801564+00:00",
"skill_id": "3934128e-cb46-433d-b4fe-550c9e6a8583",
"skill_code": "sample string 32",
"skill": {
"id": "19231745-b44c-4284-b619-8213e59c9b60",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "7da33057-eadd-4f29-b96b-07305798d9df",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2de24732-78fd-47da-bd3c-9ff268018cd8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1b13cd91-6e7f-42ae-a43f-a0f516ce7b96",
"db_currency_id": "d48c04ed-2ddb-43fe-86a9-a1ea8899ac6f",
"db_language_id": "971ea924-2437-49a6-b453-78c0c7e203bb",
"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-19T01:44:34.9801564+00:00"
},
"modified_dateutc": "2026-03-19T01:44:34.9801564+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "7230f89e-b931-42d7-94e5-a33da46be294",
"date_reported_by_company": "2026-03-19T01:44:34.9801564+00:00",
"id2": 36,
"company_id": "323f23b6-876d-4472-822c-94b3a7489e1e",
"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": "bfc5917d-0a31-4e0d-8303-6e3c14ff175d",
"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-19T01:44:34.9801564+00:00"
},
"work_instruction_details_id": "43a0234f-8805-4ac4-94e6-e096fc9fae9f",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "202abc0e-817a-469f-828d-87247a9ac5a8",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "cf8e6efa-2f38-4e1a-a993-39b289a5f336",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-03-19T01:44:34.9801564+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": "b4766947-6460-4ca3-8b18-fae17da48bd7",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-03-19T01:44:34.9801564+00:00"
}