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": "eb05bde5-32a7-4e48-a32e-6f1bb33830e6",
"jobs_id": "8ef41ebb-fdc9-4a57-9bba-bb5e9c787d90",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "728f56a8-f7c0-4fb9-a032-0fe913074049",
"_parent_id": "9f402cca-240e-47c3-8263-86dab3651183",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "7b49def3-a94b-4fbe-a050-fc04bfe17ec7",
"project_reference_back_office": "sample string 5",
"project": {
"id": "134c715a-d9bb-4d4e-9418-0ef36879ea93",
"_parent_id": "69da7db9-f17a-417a-9da3-c9c927a28a3d",
"root_parent_id": "dda19fc3-27f9-4c5e-a552-bd9c06dcd9c3",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "bdde7ab8-83ce-4511-a709-a4bb601cc9e6",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "10acc600-ae0f-44ce-b47e-100ac79f5bf7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9cb6e8e3-c34c-48b9-9fc0-c13629bd66c8",
"_parent_code": "sample string 6",
"sales_organization_id": "82efe462-9ae8-47ea-9010-9ead9fa59d3b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "11536e67-d839-4a09-a549-3be8a40dab57",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d5085c80-9b24-415b-8364-cb78615777cb",
"db_currency_id": "8dda78fb-9bce-4e2a-ac01-0f032878b781",
"db_language_id": "54cac593-0890-4592-8ac8-f890d146f425",
"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-31T21:56:31.5418784+00:00"
},
"modified_dateutc": "2026-10-31T21:56:31.5418784+00:00"
},
"equipment_model_id": "c7b78153-c5a4-451d-9135-ffd2215c1c50",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "bbd14209-779f-47fc-96e8-382d43e9d06f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "2ca0cc81-fa73-4473-a581-87d3a8b6ff8a",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "951bc224-294a-4d15-b821-08518e53730e",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "e1dcf717-1e59-4cba-8a34-d195708f8ebf",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "11536e67-d839-4a09-a549-3be8a40dab57",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d5085c80-9b24-415b-8364-cb78615777cb",
"db_currency_id": "8dda78fb-9bce-4e2a-ac01-0f032878b781",
"db_language_id": "54cac593-0890-4592-8ac8-f890d146f425",
"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-31T21:56:31.5418784+00:00"
},
"modified_dateutc": "2026-10-31T21:56:31.5418784+00:00"
},
"equipment_family_id": "92c4cb77-3076-40e2-9553-297493c38fac",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "10acc600-ae0f-44ce-b47e-100ac79f5bf7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9cb6e8e3-c34c-48b9-9fc0-c13629bd66c8",
"_parent_code": "sample string 6",
"sales_organization_id": "82efe462-9ae8-47ea-9010-9ead9fa59d3b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "11536e67-d839-4a09-a549-3be8a40dab57",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d5085c80-9b24-415b-8364-cb78615777cb",
"db_currency_id": "8dda78fb-9bce-4e2a-ac01-0f032878b781",
"db_language_id": "54cac593-0890-4592-8ac8-f890d146f425",
"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-31T21:56:31.5418784+00:00"
},
"modified_dateutc": "2026-10-31T21:56:31.5418784+00:00"
},
"date_in_production_since": "2026-10-31T21:56:31.5418784+00:00",
"date_out_of_production_since": "2026-10-31T21:56:31.5418784+00:00",
"date_end_support": "2026-10-31T21:56:31.5418784+00:00",
"sales_organization_id": "c747c997-89a9-409b-b429-909df6c7b262",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "11536e67-d839-4a09-a549-3be8a40dab57",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d5085c80-9b24-415b-8364-cb78615777cb",
"db_currency_id": "8dda78fb-9bce-4e2a-ac01-0f032878b781",
"db_language_id": "54cac593-0890-4592-8ac8-f890d146f425",
"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-31T21:56:31.5418784+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-31T21:56:31.5418784+00:00"
},
"project_status_id": "9696962e-b66a-45e4-b998-2e2253e007c5",
"project_status_code": "sample string 10",
"project_status": {
"id": "2ee79196-2fc2-4c56-80c9-7a90dae16ad3",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "e5c0bb5a-4caf-4bdf-b7da-687cf278aa3f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "11536e67-d839-4a09-a549-3be8a40dab57",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d5085c80-9b24-415b-8364-cb78615777cb",
"db_currency_id": "8dda78fb-9bce-4e2a-ac01-0f032878b781",
"db_language_id": "54cac593-0890-4592-8ac8-f890d146f425",
"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-31T21:56:31.5418784+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-31T21:56:31.5418784+00:00"
},
"company_id": "278ece4c-15d7-4be1-8056-7c974fdac8fb",
"company_code": "sample string 12",
"db_address_id": "b0f07366-a814-4002-a57e-89e076ee685e",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "63e55252-7ac0-460c-ae1e-d440c1290118",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "d7debe0e-2e98-4fb4-afb0-f92513ce7016",
"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-31T21:56:31.5418784+00:00",
"date_create": "2026-10-31T21:56:31.5418784+00:00",
"date_update": "2026-10-31T21:56:31.5418784+00:00",
"updated_by_user_id": "1fe2de69-049a-4330-8299-566960b16138",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-31T21:56:31.5418784+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-31T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-31T21:56:31.5418784+00:00",
"date_last_job": "2026-10-31T21:56:31.5418784+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-31T21:56:31.5418784+00:00",
"modified_dateutc": "2026-10-31T21:56:31.5418784+00:00",
"is_mobile_installation": true
},
"job_type_id": "908ca25d-2b89-4385-a7f3-854a99a09a65",
"job_type_code": "sample string 7",
"job_type": {
"id": "0d3666b3-ad26-4bb3-b039-0e55a14e6b8f",
"name": "sample string 2",
"sales_organization_id": "fbbabce5-b172-43a6-941d-38fd5b3eba22",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-31T21:56:31.5418784+00:00",
"code": "sample string 7"
},
"job_priority_id": "d1f5fc5b-467b-47bf-93e6-d18ab0b788c3",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "2f71f7c4-9b5b-4621-b0c7-33eab17ce6b8",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "6f380f75-d728-4078-94b6-5ec8199dc745",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "11536e67-d839-4a09-a549-3be8a40dab57",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d5085c80-9b24-415b-8364-cb78615777cb",
"db_currency_id": "8dda78fb-9bce-4e2a-ac01-0f032878b781",
"db_language_id": "54cac593-0890-4592-8ac8-f890d146f425",
"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-31T21:56:31.5418784+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-31T21:56:31.5418784+00:00"
},
"job_status_id": "99ec46ac-f700-4f1b-a9f2-957891754782",
"job_status_code": "sample string 11",
"db_address_id": "039ed850-2bde-4ecf-b13b-f4cbd0ee9d90",
"contact_id": "020a3969-89ba-4a13-be92-191716b85d3a",
"requested_by_company_id": "81ad90af-8ac7-4e51-97f6-a601bf280fcc",
"requested_by_contact_id": "04b0b510-0db8-4bfd-9a28-519baebaa396",
"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-31T21:56:31.5418784+00:00",
"due_date": "2026-10-31T21:56:31.5418784+00:00",
"date_create": "2026-10-31T21:56:31.5418784+00:00",
"date_update": "2026-10-31T21:56:31.5418784+00:00",
"date_closed": "2026-10-31T21:56:31.5418784+00:00",
"suggested_user_id": "18b9bd30-460a-400e-b967-b5a20ed45dd5",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "485da2b6-ecee-421a-bcca-90a59a2b3595",
"db_language_id": "1c56f654-ac9b-4347-a1de-4b2af452df4f",
"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-31T21:56:31.5418784+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "1b9b392b-836e-4b81-9f25-7362ef137b90",
"sales_organization": {
"id": "11536e67-d839-4a09-a549-3be8a40dab57",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d5085c80-9b24-415b-8364-cb78615777cb",
"db_currency_id": "8dda78fb-9bce-4e2a-ac01-0f032878b781",
"db_language_id": "54cac593-0890-4592-8ac8-f890d146f425",
"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-31T21:56:31.5418784+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "1f2bc20d-007e-4aac-8700-ddc67676a399",
"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": "1229d30d-0d96-4fc3-aa93-f51d28816647",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-31T21:56:31.5418784+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "43c96ab5-cf80-47ea-bc40-e8dee6d49344"
},
"suggested_date_start": "2026-10-31T21:56:31.5418784+00:00",
"skill_id": "8ab6def4-38b2-4cf2-8835-806e4074a933",
"skill_code": "sample string 32",
"skill": {
"id": "40c29086-1657-4f84-85cb-c9fc7ef59187",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "6580bab0-2da3-4abe-bed6-2013b6ebb8b0",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "11536e67-d839-4a09-a549-3be8a40dab57",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d5085c80-9b24-415b-8364-cb78615777cb",
"db_currency_id": "8dda78fb-9bce-4e2a-ac01-0f032878b781",
"db_language_id": "54cac593-0890-4592-8ac8-f890d146f425",
"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-31T21:56:31.5418784+00:00"
},
"modified_dateutc": "2026-10-31T21:56:31.5418784+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "4093f6f5-ed63-4d33-904e-263c7fdbcc0a",
"date_reported_by_company": "2026-10-31T21:56:31.5418784+00:00",
"id2": 36,
"company_id": "e2a242bb-6981-4b80-8021-b31b4dbd66f7",
"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": "fc2ddb45-c34c-4cfa-8c8c-619ee2e12ef8",
"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-31T21:56:31.5418784+00:00"
},
"work_instruction_details_id": "d33dc49e-ff3d-420e-b20c-3d1190a19eec",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "d1a543d5-5363-4fd1-8c7a-442eeb468ef3",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "3d12bcea-9838-47d1-83d6-723d2e73addc",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-31T21:56:31.5418784+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": "b800b3ad-5819-4928-b31c-ffe5f11f65fe",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-31T21:56:31.5418784+00:00"
}