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": "ee6375b7-ddab-43c0-b808-ee3ec61f29ee",
"jobs_id": "f315547d-5d8a-480c-afe0-f7d398907819",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "1c7d0099-9cef-47c2-9926-0b2c8a756a70",
"_parent_id": "341b0da7-9ccd-4add-a6a6-f036b28b1aa5",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "05d9332a-58c1-44bc-8f84-b2727b106d1d",
"project_reference_back_office": "sample string 5",
"project": {
"id": "a3851bf9-555a-4e72-8b7e-2a65102a0067",
"_parent_id": "9084bcdc-3146-4811-addd-c07d7049cd58",
"root_parent_id": "376d2561-3233-48e9-ba18-f9d6976a6f76",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "7990fbc4-06fa-43d6-b09a-83eed0cda3c7",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "5d6d6446-418f-4102-adcc-85e6aaaa540f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a7d9da85-6f66-412d-af82-08e7bdad5ee6",
"_parent_code": "sample string 6",
"sales_organization_id": "a3205351-4ca5-4b9a-92ad-d84c715d5c0c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "76863dbe-e20f-4c4b-8be8-89704e250676",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "866695bb-f25d-45e9-a456-963f258576ba",
"db_currency_id": "80b773b9-b2b4-4ac5-8ad8-b212e01d7b81",
"db_language_id": "d30d73d0-80fb-40ab-b94f-31d8e316b566",
"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": "2025-05-07T07:12:08.4303339+00:00"
},
"modified_dateutc": "2025-05-07T07:12:08.4303339+00:00"
},
"equipment_model_id": "3e861957-9305-4418-b6e9-f964164bfbed",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "9c756d0d-677a-4316-b23e-01507a2bc31f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "fcbb5786-192a-46dd-8564-18f500b3ba47",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "f66a1248-7b1f-4c92-9976-d96923c7207f",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "2098f29e-931c-496b-93f6-8380cc896f30",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "76863dbe-e20f-4c4b-8be8-89704e250676",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "866695bb-f25d-45e9-a456-963f258576ba",
"db_currency_id": "80b773b9-b2b4-4ac5-8ad8-b212e01d7b81",
"db_language_id": "d30d73d0-80fb-40ab-b94f-31d8e316b566",
"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": "2025-05-07T07:12:08.4303339+00:00"
},
"modified_dateutc": "2025-05-07T07:12:08.4303339+00:00"
},
"equipment_family_id": "98473c23-ff4e-424c-bbc5-f858a19c10cd",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "5d6d6446-418f-4102-adcc-85e6aaaa540f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a7d9da85-6f66-412d-af82-08e7bdad5ee6",
"_parent_code": "sample string 6",
"sales_organization_id": "a3205351-4ca5-4b9a-92ad-d84c715d5c0c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "76863dbe-e20f-4c4b-8be8-89704e250676",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "866695bb-f25d-45e9-a456-963f258576ba",
"db_currency_id": "80b773b9-b2b4-4ac5-8ad8-b212e01d7b81",
"db_language_id": "d30d73d0-80fb-40ab-b94f-31d8e316b566",
"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": "2025-05-07T07:12:08.4303339+00:00"
},
"modified_dateutc": "2025-05-07T07:12:08.4303339+00:00"
},
"date_in_production_since": "2025-05-07T07:12:08.4303339+00:00",
"date_out_of_production_since": "2025-05-07T07:12:08.4303339+00:00",
"date_end_support": "2025-05-07T07:12:08.4303339+00:00",
"sales_organization_id": "357efeef-ce43-48bb-81d3-9bca3b6cff8a",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "76863dbe-e20f-4c4b-8be8-89704e250676",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "866695bb-f25d-45e9-a456-963f258576ba",
"db_currency_id": "80b773b9-b2b4-4ac5-8ad8-b212e01d7b81",
"db_language_id": "d30d73d0-80fb-40ab-b94f-31d8e316b566",
"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": "2025-05-07T07:12:08.4303339+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": "2025-05-07T07:12:08.4459596+00:00"
},
"project_status_id": "d354b62f-e8c2-423f-b3f5-a73a8945bba2",
"project_status_code": "sample string 10",
"project_status": {
"id": "f5012f31-3518-423d-9dda-14122ff6efa3",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "0b696e70-1e7e-4ddc-8a44-2de6f5612b6d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "76863dbe-e20f-4c4b-8be8-89704e250676",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "866695bb-f25d-45e9-a456-963f258576ba",
"db_currency_id": "80b773b9-b2b4-4ac5-8ad8-b212e01d7b81",
"db_language_id": "d30d73d0-80fb-40ab-b94f-31d8e316b566",
"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": "2025-05-07T07:12:08.4303339+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-05-07T07:12:08.4459596+00:00"
},
"company_id": "0335f86d-803a-4d98-acfd-e9e0d0aea642",
"company_code": "sample string 12",
"db_address_id": "170ea504-6b20-4269-89b9-a5b05d325d3a",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "4748f03f-36ec-404a-ba9b-39ed4ccae8f0",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "861c86bb-402d-49c3-858b-f7afb12a6c16",
"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": "2025-05-07T07:12:08.4459596+00:00",
"date_create": "2025-05-07T07:12:08.4459596+00:00",
"date_update": "2025-05-07T07:12:08.4459596+00:00",
"updated_by_user_id": "7a344d2f-97e6-4d7a-ab5d-1e31dd23771b",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-05-07T07:12:08.4459596+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": "2025-05-07T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-05-07T07:12:08.4459596+00:00",
"date_last_job": "2025-05-07T07:12:08.4459596+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-05-07T07:12:08.4459596+00:00",
"modified_dateutc": "2025-05-07T07:12:08.4459596+00:00",
"is_mobile_installation": true
},
"job_type_id": "cb7a891c-8f15-4f54-b6a6-4bbcd760ce10",
"job_type_code": "sample string 7",
"job_type": {
"id": "3075e46a-dee9-407b-a450-9d0a5bae160a",
"name": "sample string 2",
"sales_organization_id": "b74ae8a4-e1ba-42f3-ad0a-8467d6cc5300",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-05-07T07:12:08.4459596+00:00",
"code": "sample string 7"
},
"job_priority_id": "a6b26db2-3464-4256-b8d4-7126f6ad3a24",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "2e6226bf-7bf4-41f6-b109-d44ba664d9a6",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "a5300556-c39e-4dd8-8f05-a1fbabf45a34",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "76863dbe-e20f-4c4b-8be8-89704e250676",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "866695bb-f25d-45e9-a456-963f258576ba",
"db_currency_id": "80b773b9-b2b4-4ac5-8ad8-b212e01d7b81",
"db_language_id": "d30d73d0-80fb-40ab-b94f-31d8e316b566",
"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": "2025-05-07T07:12:08.4303339+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-05-07T07:12:08.4459596+00:00"
},
"job_status_id": "c03b4580-97c2-4cc9-b66e-af481a044f8d",
"job_status_code": "sample string 11",
"db_address_id": "290a3b85-b972-498c-b83f-6f9e838119a6",
"contact_id": "20a14c3a-f21e-4f3c-92cc-83b42484463a",
"requested_by_company_id": "e0c05dcc-f4fc-4f08-be53-6ac343dbf7e4",
"requested_by_contact_id": "cfbd86be-b631-4cc1-b701-4df381906520",
"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": "2025-05-07T07:12:08.4459596+00:00",
"due_date": "2025-05-07T07:12:08.4459596+00:00",
"date_create": "2025-05-07T07:12:08.4459596+00:00",
"date_update": "2025-05-07T07:12:08.4459596+00:00",
"date_closed": "2025-05-07T07:12:08.4459596+00:00",
"suggested_user_id": "53bc5dee-8584-4482-9e26-98107cca0517",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "e34dad72-9f27-49da-a546-96d50f56ada7",
"db_language_id": "d3c9d260-aa8d-48be-bfbf-a8b0a7da16b7",
"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": "2025-05-07T07:12:08.4459596+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "c0884592-1958-484e-9e22-27d4c5a6bc0d",
"sales_organization": {
"id": "76863dbe-e20f-4c4b-8be8-89704e250676",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "866695bb-f25d-45e9-a456-963f258576ba",
"db_currency_id": "80b773b9-b2b4-4ac5-8ad8-b212e01d7b81",
"db_language_id": "d30d73d0-80fb-40ab-b94f-31d8e316b566",
"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": "2025-05-07T07:12:08.4303339+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "d97b9ea6-f96e-4a1f-85e9-b5b08ae2913d",
"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": "ee3566c4-8afb-479f-b839-a8362985ba98",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-05-07T07:12:08.4459596+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "5ba5d9bd-d8ca-4a9e-a344-b4b74afbf179"
},
"suggested_date_start": "2025-05-07T07:12:08.4459596+00:00",
"skill_id": "ff5f9025-935d-4c11-aa80-7cdc52e10875",
"skill_code": "sample string 32",
"skill": {
"id": "7e500c32-6b2b-4526-8264-c95e7e093950",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "5624e94c-5365-4c51-89bc-2f2501a6c3c8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "76863dbe-e20f-4c4b-8be8-89704e250676",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "866695bb-f25d-45e9-a456-963f258576ba",
"db_currency_id": "80b773b9-b2b4-4ac5-8ad8-b212e01d7b81",
"db_language_id": "d30d73d0-80fb-40ab-b94f-31d8e316b566",
"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": "2025-05-07T07:12:08.4303339+00:00"
},
"modified_dateutc": "2025-05-07T07:12:08.4459596+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "aa7db264-3f29-47e2-b946-e2d08cb19cc2",
"date_reported_by_company": "2025-05-07T07:12:08.4459596+00:00",
"id2": 36,
"company_id": "bb54f4d0-1f12-430f-a5e9-7a1f35095a97",
"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": "27675e1c-6fb9-4274-b44e-46c169bfbfde",
"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": "2025-05-07T07:12:08.4459596+00:00"
},
"work_instruction_details_id": "2630f4c7-73e9-402a-9f78-7f4fe816eff7",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "b0f70588-98d2-42b4-b361-4f2d17c296e5",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "43325936-514c-4902-ab18-051f38c56c34",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-05-07T07:12:08.4459596+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": "a99b5bdb-c527-4154-8828-199d293c276d",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-05-07T07:12:08.4459596+00:00"
}