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": "8ff079cd-abaf-4791-8398-497074f330b3",
"jobs_id": "61371348-bd1b-4ad4-8f76-10012daaee54",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "4bed9905-d45a-40b7-8479-c9775d947d11",
"_parent_id": "08d323fb-bbad-4796-8b68-23f6391c48ac",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "12b51383-2d9a-40a3-b87d-6f0011e7cdcc",
"project_reference_back_office": "sample string 5",
"project": {
"id": "e35073a6-2242-482c-8037-8e1311a8209c",
"_parent_id": "a0633118-57a3-42a7-afcf-e00fa04b4619",
"root_parent_id": "a4479c25-e885-4457-8844-53546701c512",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "8d9ce38a-dc7e-49aa-8564-c1392ab35148",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "ce5ae06d-a47f-4276-96b1-5130e2750701",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "4123290d-c464-4ed1-a2dd-da1f98d1063a",
"_parent_code": "sample string 6",
"sales_organization_id": "85ebe53b-c027-48d9-aa45-20d413953380",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "cccd0979-b03d-49a8-b216-c61c0dc7d4c7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "83e8e673-ec61-4712-9b44-3f8a5822405c",
"db_currency_id": "9c34b983-af54-442c-b9bd-7cca1cdf6711",
"db_language_id": "04157d75-0b0b-42f0-9621-23f7ecfaeeff",
"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-04-03T18:57:46.9736972+00:00"
},
"modified_dateutc": "2026-04-03T18:57:46.9736972+00:00"
},
"equipment_model_id": "fd9db1a8-89ad-44eb-bb9b-2f08a3998fd9",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "f6b3708a-3c9f-4438-83b3-1724322aedcb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "ef3ff484-2700-4c5c-9ed7-0827e6ba572c",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "d8d2c8aa-df98-496f-beca-c72951991598",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "23f32b9e-83f2-4e23-a28a-a71ad4f31102",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "cccd0979-b03d-49a8-b216-c61c0dc7d4c7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "83e8e673-ec61-4712-9b44-3f8a5822405c",
"db_currency_id": "9c34b983-af54-442c-b9bd-7cca1cdf6711",
"db_language_id": "04157d75-0b0b-42f0-9621-23f7ecfaeeff",
"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-04-03T18:57:46.9736972+00:00"
},
"modified_dateutc": "2026-04-03T18:57:46.9736972+00:00"
},
"equipment_family_id": "1ce847f0-6838-49cc-94d2-6bb9801373b3",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "ce5ae06d-a47f-4276-96b1-5130e2750701",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "4123290d-c464-4ed1-a2dd-da1f98d1063a",
"_parent_code": "sample string 6",
"sales_organization_id": "85ebe53b-c027-48d9-aa45-20d413953380",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "cccd0979-b03d-49a8-b216-c61c0dc7d4c7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "83e8e673-ec61-4712-9b44-3f8a5822405c",
"db_currency_id": "9c34b983-af54-442c-b9bd-7cca1cdf6711",
"db_language_id": "04157d75-0b0b-42f0-9621-23f7ecfaeeff",
"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-04-03T18:57:46.9736972+00:00"
},
"modified_dateutc": "2026-04-03T18:57:46.9736972+00:00"
},
"date_in_production_since": "2026-04-03T18:57:46.9736972+00:00",
"date_out_of_production_since": "2026-04-03T18:57:46.9736972+00:00",
"date_end_support": "2026-04-03T18:57:46.9736972+00:00",
"sales_organization_id": "a3ad8582-5aa1-4883-b0a9-19b3efe9982e",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "cccd0979-b03d-49a8-b216-c61c0dc7d4c7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "83e8e673-ec61-4712-9b44-3f8a5822405c",
"db_currency_id": "9c34b983-af54-442c-b9bd-7cca1cdf6711",
"db_language_id": "04157d75-0b0b-42f0-9621-23f7ecfaeeff",
"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-04-03T18:57:46.9736972+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-04-03T18:57:46.9736972+00:00"
},
"project_status_id": "45d0b1ff-5dc1-4427-b469-c42c146b8111",
"project_status_code": "sample string 10",
"project_status": {
"id": "f480ec54-6680-4159-9559-746dcc9d8614",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "3977846b-4e9a-4770-b6c8-57271642d618",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "cccd0979-b03d-49a8-b216-c61c0dc7d4c7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "83e8e673-ec61-4712-9b44-3f8a5822405c",
"db_currency_id": "9c34b983-af54-442c-b9bd-7cca1cdf6711",
"db_language_id": "04157d75-0b0b-42f0-9621-23f7ecfaeeff",
"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-04-03T18:57:46.9736972+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-03T18:57:46.9736972+00:00"
},
"company_id": "eb31bd73-eb3d-4057-aa79-ed41076f14c3",
"company_code": "sample string 12",
"db_address_id": "4f0f64f1-5f90-46fc-ad1d-dd17762c1a0c",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "2dab66bb-a8d5-46b6-a449-b1d6c02f40de",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "444c6142-7f03-480c-b801-ce386732889c",
"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-04-03T18:57:46.9736972+00:00",
"date_create": "2026-04-03T18:57:46.9736972+00:00",
"date_update": "2026-04-03T18:57:46.9736972+00:00",
"updated_by_user_id": "e4bc66d2-0d4a-4ba3-a7f8-9e9814960a9d",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-04-03T18:57:46.9736972+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-04-03T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-04-03T18:57:46.9736972+00:00",
"date_last_job": "2026-04-03T18:57:46.9736972+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-04-03T18:57:46.9736972+00:00",
"modified_dateutc": "2026-04-03T18:57:46.9736972+00:00",
"is_mobile_installation": true
},
"job_type_id": "4814370b-3eb7-45dd-9e89-04f645810382",
"job_type_code": "sample string 7",
"job_type": {
"id": "f90a8ee0-4094-471b-ba27-1985796bb596",
"name": "sample string 2",
"sales_organization_id": "e979fc45-8e85-4eed-bc63-2ef6b2e555c5",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-04-03T18:57:46.9736972+00:00",
"code": "sample string 7"
},
"job_priority_id": "0a9fd433-291c-428e-86e7-ccfcaaa0c11d",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "837540a3-f80b-4b60-8fc7-1313bdb8302f",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "436c05c5-677d-4294-9900-c6ced37c86ed",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "cccd0979-b03d-49a8-b216-c61c0dc7d4c7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "83e8e673-ec61-4712-9b44-3f8a5822405c",
"db_currency_id": "9c34b983-af54-442c-b9bd-7cca1cdf6711",
"db_language_id": "04157d75-0b0b-42f0-9621-23f7ecfaeeff",
"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-04-03T18:57:46.9736972+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-03T18:57:46.9736972+00:00"
},
"job_status_id": "a053aec2-3398-4a34-9333-36ceeba0d1b4",
"job_status_code": "sample string 11",
"db_address_id": "718f9971-19db-4be9-8625-21ca3da68b43",
"contact_id": "9911ccfe-0bd5-4878-bc1e-4a4f2872351c",
"requested_by_company_id": "52ed7efc-014d-4b5c-851a-f2233da9a28f",
"requested_by_contact_id": "d23f17e8-01fd-449b-a025-dca8cb160b30",
"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-04-03T18:57:46.9736972+00:00",
"due_date": "2026-04-03T18:57:46.9736972+00:00",
"date_create": "2026-04-03T18:57:46.9736972+00:00",
"date_update": "2026-04-03T18:57:46.9736972+00:00",
"date_closed": "2026-04-03T18:57:46.9736972+00:00",
"suggested_user_id": "493c8c93-6258-47de-a3d9-b43414e84e3b",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "73d18508-2de8-4487-a63b-7a1127660500",
"db_language_id": "2c1f658e-9fc9-4a4c-969b-e2cd6d736584",
"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-04-03T18:57:46.9736972+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "7366f7ba-41f2-4405-845d-0f470cc7341c",
"sales_organization": {
"id": "cccd0979-b03d-49a8-b216-c61c0dc7d4c7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "83e8e673-ec61-4712-9b44-3f8a5822405c",
"db_currency_id": "9c34b983-af54-442c-b9bd-7cca1cdf6711",
"db_language_id": "04157d75-0b0b-42f0-9621-23f7ecfaeeff",
"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-04-03T18:57:46.9736972+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "e7eec8a9-c31a-4095-9a02-4ab834d0bc74",
"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": "eb526f48-3d82-4ae0-b5df-51da2c392707",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-04-03T18:57:46.9736972+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "c0c0b0cc-6034-451f-b8ef-041d01a8873c"
},
"suggested_date_start": "2026-04-03T18:57:46.9736972+00:00",
"skill_id": "43731e5a-bbc2-4630-8251-ae3b1d2b4cf2",
"skill_code": "sample string 32",
"skill": {
"id": "c80c7093-3a47-405a-8231-c3f64415b6cc",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "42e445de-d1d9-401c-a9f6-d3c827a6bce8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "cccd0979-b03d-49a8-b216-c61c0dc7d4c7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "83e8e673-ec61-4712-9b44-3f8a5822405c",
"db_currency_id": "9c34b983-af54-442c-b9bd-7cca1cdf6711",
"db_language_id": "04157d75-0b0b-42f0-9621-23f7ecfaeeff",
"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-04-03T18:57:46.9736972+00:00"
},
"modified_dateutc": "2026-04-03T18:57:46.9736972+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "fe50e780-4a1e-41fa-bee0-9c96ba91d1a5",
"date_reported_by_company": "2026-04-03T18:57:46.9736972+00:00",
"id2": 36,
"company_id": "e69bc91d-4f95-4e8f-864c-3aced16d0b06",
"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": "8c9a3676-b97b-4ba3-8485-a5520dec0df3",
"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-04-03T18:57:46.9736972+00:00"
},
"work_instruction_details_id": "71b0d4ff-81ab-45b0-b2f6-67785f14e887",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "6ff040e3-84c8-4ae4-a539-3e6630a996e0",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "caf25a03-56b3-4869-bb03-94fd8aa685ea",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-04-03T18:57:46.9736972+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": "27807218-163d-4b65-bcb6-6b53dcce5604",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-04-03T18:57:46.9736972+00:00"
}