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": "45da4c65-18a0-4112-904c-5d0f1a34e52c",
"jobs_id": "5893e1e2-0023-401d-9e35-72f61483d671",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "1409554c-ae2a-4dca-9cff-001c046c9d27",
"_parent_id": "587e9ede-1eb2-4e7e-b081-298aa982614b",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "c4f7632e-046e-412d-829e-4000be6522f4",
"project_reference_back_office": "sample string 5",
"project": {
"id": "3ffba4ad-2e83-4f64-8e26-f0dca8b13152",
"_parent_id": "c9d14594-8e04-49c8-a9a7-dd857540d9db",
"root_parent_id": "735d229f-b42a-4ae4-a9a4-d2a24ba47e73",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "d5c8b16a-210b-48da-9238-5d6671768618",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "a4a744fb-7be8-4d36-ae15-71335fe97709",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "224151a3-cba0-410f-9bd7-1de932ccb089",
"_parent_code": "sample string 6",
"sales_organization_id": "f9b9759e-5e07-4287-91e8-affb31feb531",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "2b72373f-b55c-47b3-b9a6-8fe032e67c41",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6786bda3-b9a2-4a85-b7b2-082031b59c2e",
"db_currency_id": "5c430e66-f2c8-4249-ab3c-08aeab225ff0",
"db_language_id": "a571d1dd-811c-43ee-afd9-dd2d3c4c5dc0",
"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-06-27T12:45:34.9951641+00:00"
},
"modified_dateutc": "2025-06-27T12:45:34.9951641+00:00"
},
"equipment_model_id": "5ebf113a-7446-49a6-b850-437f7ce2b0ea",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "64d7a0c1-f1dd-4a18-8bae-6657b4ec7414",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "e02f81da-7178-465c-a4ae-cc37921580bb",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "ef3c14ac-cdf0-42c1-8360-3675b9128b45",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "6dba3a0a-f8b4-48e1-b78c-24c149315f0f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2b72373f-b55c-47b3-b9a6-8fe032e67c41",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6786bda3-b9a2-4a85-b7b2-082031b59c2e",
"db_currency_id": "5c430e66-f2c8-4249-ab3c-08aeab225ff0",
"db_language_id": "a571d1dd-811c-43ee-afd9-dd2d3c4c5dc0",
"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-06-27T12:45:34.9951641+00:00"
},
"modified_dateutc": "2025-06-27T12:45:34.9951641+00:00"
},
"equipment_family_id": "eb3788d7-0048-4892-ac4b-a492f5c04351",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "a4a744fb-7be8-4d36-ae15-71335fe97709",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "224151a3-cba0-410f-9bd7-1de932ccb089",
"_parent_code": "sample string 6",
"sales_organization_id": "f9b9759e-5e07-4287-91e8-affb31feb531",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "2b72373f-b55c-47b3-b9a6-8fe032e67c41",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6786bda3-b9a2-4a85-b7b2-082031b59c2e",
"db_currency_id": "5c430e66-f2c8-4249-ab3c-08aeab225ff0",
"db_language_id": "a571d1dd-811c-43ee-afd9-dd2d3c4c5dc0",
"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-06-27T12:45:34.9951641+00:00"
},
"modified_dateutc": "2025-06-27T12:45:34.9951641+00:00"
},
"date_in_production_since": "2025-06-27T12:45:34.9951641+00:00",
"date_out_of_production_since": "2025-06-27T12:45:34.9951641+00:00",
"date_end_support": "2025-06-27T12:45:34.9951641+00:00",
"sales_organization_id": "f200216b-6c5b-4934-9983-94a9179c187a",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "2b72373f-b55c-47b3-b9a6-8fe032e67c41",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6786bda3-b9a2-4a85-b7b2-082031b59c2e",
"db_currency_id": "5c430e66-f2c8-4249-ab3c-08aeab225ff0",
"db_language_id": "a571d1dd-811c-43ee-afd9-dd2d3c4c5dc0",
"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-06-27T12:45:34.9951641+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-06-27T12:45:35.0107899+00:00"
},
"project_status_id": "fd823673-8065-498f-b51a-0c5f2f48d957",
"project_status_code": "sample string 10",
"project_status": {
"id": "ae62e026-17f3-4b6d-a62e-a60a80f03dd9",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "1bde287a-09bd-41e3-9754-778899bdd028",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2b72373f-b55c-47b3-b9a6-8fe032e67c41",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6786bda3-b9a2-4a85-b7b2-082031b59c2e",
"db_currency_id": "5c430e66-f2c8-4249-ab3c-08aeab225ff0",
"db_language_id": "a571d1dd-811c-43ee-afd9-dd2d3c4c5dc0",
"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-06-27T12:45:34.9951641+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-06-27T12:45:35.0107899+00:00"
},
"company_id": "419e63b3-af04-40de-ae28-64d79908fe39",
"company_code": "sample string 12",
"db_address_id": "72e5236a-f9b3-44ce-aca9-66209b004db9",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "c2693413-ff16-4c23-b6af-5f669e05a64d",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "82fd6ea1-ed81-48da-b46f-6775a38a3dbc",
"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-06-27T12:45:35.0107899+00:00",
"date_create": "2025-06-27T12:45:35.0107899+00:00",
"date_update": "2025-06-27T12:45:35.0107899+00:00",
"updated_by_user_id": "28e9bf4f-2f77-4ee4-b591-44acdbfb240e",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-06-27T12:45:35.0107899+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-06-27T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-06-27T12:45:35.0107899+00:00",
"date_last_job": "2025-06-27T12:45:35.0107899+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-06-27T12:45:35.0107899+00:00",
"modified_dateutc": "2025-06-27T12:45:35.0107899+00:00",
"is_mobile_installation": true
},
"job_type_id": "58d58aba-ae28-4203-8c9d-94c4b6544d67",
"job_type_code": "sample string 7",
"job_type": {
"id": "8f71abbc-cffb-4e10-968d-f6af663110cb",
"name": "sample string 2",
"sales_organization_id": "9ddb0eec-340f-49d4-9dc0-c1f48c7f6ed2",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-06-27T12:45:35.0107899+00:00",
"code": "sample string 7"
},
"job_priority_id": "ca6d7ad4-659a-44ac-8fbb-0380a744e434",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "64c27cd8-f8cd-420e-973a-6782dec44573",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "34e80312-3b44-4297-9fe2-852c998f2c49",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2b72373f-b55c-47b3-b9a6-8fe032e67c41",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6786bda3-b9a2-4a85-b7b2-082031b59c2e",
"db_currency_id": "5c430e66-f2c8-4249-ab3c-08aeab225ff0",
"db_language_id": "a571d1dd-811c-43ee-afd9-dd2d3c4c5dc0",
"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-06-27T12:45:34.9951641+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-06-27T12:45:35.0107899+00:00"
},
"job_status_id": "379280c1-96d8-4440-bb97-27e7a5e4c4d5",
"job_status_code": "sample string 11",
"db_address_id": "04a6e31d-3b3c-4766-9ad8-d25769c7a752",
"contact_id": "7b6fb605-ac50-4508-820c-c1805902b2bf",
"requested_by_company_id": "68f82fbd-37c5-4fba-bd8b-e51d93e1df2f",
"requested_by_contact_id": "748777d3-efe2-401b-8020-6a008aeb7c6c",
"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-06-27T12:45:35.0107899+00:00",
"due_date": "2025-06-27T12:45:35.0107899+00:00",
"date_create": "2025-06-27T12:45:35.0107899+00:00",
"date_update": "2025-06-27T12:45:35.0107899+00:00",
"date_closed": "2025-06-27T12:45:35.0107899+00:00",
"suggested_user_id": "d4fc1f33-cd7a-4f02-be90-86d0653ee68e",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "df0568b5-d457-4258-a0bf-f90529f58734",
"db_language_id": "b8b8fb57-068a-4b02-adf8-b17e628d3df7",
"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-06-27T12:45:35.0107899+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "1844d96e-f570-4046-b279-c078ac9edb0e",
"sales_organization": {
"id": "2b72373f-b55c-47b3-b9a6-8fe032e67c41",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6786bda3-b9a2-4a85-b7b2-082031b59c2e",
"db_currency_id": "5c430e66-f2c8-4249-ab3c-08aeab225ff0",
"db_language_id": "a571d1dd-811c-43ee-afd9-dd2d3c4c5dc0",
"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-06-27T12:45:34.9951641+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "61bcbc26-3662-4577-9f33-d078ac12ea3e",
"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": "8a0ac2ff-08b7-4418-8f98-8060b386ed82",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-06-27T12:45:35.0107899+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "7be2c140-7e95-4fbe-8080-707e400bb653"
},
"suggested_date_start": "2025-06-27T12:45:35.0107899+00:00",
"skill_id": "bf74406b-71ec-4dad-86f8-5ba8dea1b103",
"skill_code": "sample string 32",
"skill": {
"id": "7f222b8f-e930-4d8c-a4ce-188dc7430773",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "79c2817e-2128-4d92-b9a3-fd0b477a2b21",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2b72373f-b55c-47b3-b9a6-8fe032e67c41",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6786bda3-b9a2-4a85-b7b2-082031b59c2e",
"db_currency_id": "5c430e66-f2c8-4249-ab3c-08aeab225ff0",
"db_language_id": "a571d1dd-811c-43ee-afd9-dd2d3c4c5dc0",
"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-06-27T12:45:34.9951641+00:00"
},
"modified_dateutc": "2025-06-27T12:45:35.0107899+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "0827b2bf-e64f-4239-9e1a-e6f3b451f25d",
"date_reported_by_company": "2025-06-27T12:45:35.0107899+00:00",
"id2": 36,
"company_id": "65256298-799c-46ca-a76b-16440cd8f3ec",
"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": "9de9eedf-d3e2-4199-b91f-cd367b4671a9",
"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-06-27T12:45:35.0107899+00:00"
},
"work_instruction_details_id": "b76b4235-5735-438e-9c18-097ad6f9b76f",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "15ee53f1-088f-4f63-9f05-98a67975761e",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "6be882cf-50f1-41cf-b29f-2642a8cfc52e",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-06-27T12:45:35.0107899+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": "4310fcbd-96f0-4798-8424-0f6380b78d91",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-06-27T12:45:35.0107899+00:00"
}