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": "f8cf2b4b-1f4e-4795-8956-67d3d5029e87",
"jobs_id": "203880d7-41fd-4a4a-aaf4-210db37ebd9f",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "44017f03-a9b6-4bad-bdfe-887a9ab6b828",
"_parent_id": "d46a21c4-3dbe-4162-9bc2-fd65fea0af8a",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "b95a6318-2bb6-4022-bc41-8e216005f034",
"project_reference_back_office": "sample string 5",
"project": {
"id": "dae03f5e-73b3-423f-b76c-5415b9f7ce61",
"_parent_id": "61bc5e4e-29c3-40c3-8f40-6de0c2716ac6",
"root_parent_id": "95be2785-0522-47ab-bada-e4aecb2a58d3",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "090765b5-74f3-4ab9-89ad-55a8ba960bb3",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "cb319cc3-f61c-4397-99bf-172cfe589ae1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "fa5156d1-21b5-46e7-b755-978b94b57f63",
"_parent_code": "sample string 6",
"sales_organization_id": "81fb992f-6799-493c-9891-ce239b755e52",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "6690a459-3001-4c74-8448-907ca2178876",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4aabff33-40f1-4a2c-b795-fc8a7aad337a",
"db_currency_id": "8f1f30a5-876f-45cc-9a19-289d0d971817",
"db_language_id": "c227489e-6f02-40d5-ba25-f36ec4da907d",
"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-11-12T07:17:44.9031192+00:00"
},
"modified_dateutc": "2025-11-12T07:17:44.9031192+00:00"
},
"equipment_model_id": "033474ea-f0a2-4b98-a849-6d15cae930e7",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "b77fa6d5-f275-4259-be60-b894c558832c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "3db1d86f-4c37-4333-9c70-6b13ed5e6f87",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "50b08d98-bef8-46f0-9cd0-ea05b914a83a",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "a40c52e1-4fc0-4c9d-9112-8606aebdf51c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6690a459-3001-4c74-8448-907ca2178876",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4aabff33-40f1-4a2c-b795-fc8a7aad337a",
"db_currency_id": "8f1f30a5-876f-45cc-9a19-289d0d971817",
"db_language_id": "c227489e-6f02-40d5-ba25-f36ec4da907d",
"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-11-12T07:17:44.9031192+00:00"
},
"modified_dateutc": "2025-11-12T07:17:44.9031192+00:00"
},
"equipment_family_id": "08a7458f-109a-4d8a-963e-8d58351d1b71",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "cb319cc3-f61c-4397-99bf-172cfe589ae1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "fa5156d1-21b5-46e7-b755-978b94b57f63",
"_parent_code": "sample string 6",
"sales_organization_id": "81fb992f-6799-493c-9891-ce239b755e52",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "6690a459-3001-4c74-8448-907ca2178876",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4aabff33-40f1-4a2c-b795-fc8a7aad337a",
"db_currency_id": "8f1f30a5-876f-45cc-9a19-289d0d971817",
"db_language_id": "c227489e-6f02-40d5-ba25-f36ec4da907d",
"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-11-12T07:17:44.9031192+00:00"
},
"modified_dateutc": "2025-11-12T07:17:44.9031192+00:00"
},
"date_in_production_since": "2025-11-12T07:17:44.9031192+00:00",
"date_out_of_production_since": "2025-11-12T07:17:44.9031192+00:00",
"date_end_support": "2025-11-12T07:17:44.9031192+00:00",
"sales_organization_id": "fbd51b46-a22b-4830-a510-628e24330d33",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "6690a459-3001-4c74-8448-907ca2178876",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4aabff33-40f1-4a2c-b795-fc8a7aad337a",
"db_currency_id": "8f1f30a5-876f-45cc-9a19-289d0d971817",
"db_language_id": "c227489e-6f02-40d5-ba25-f36ec4da907d",
"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-11-12T07:17:44.9031192+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-11-12T07:17:44.9031192+00:00"
},
"project_status_id": "324c35fa-46e9-4bc4-b860-e7263fc9bef1",
"project_status_code": "sample string 10",
"project_status": {
"id": "1f0d7705-2b4f-467d-a759-a9201edb72f1",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "8ff7b9b3-8f72-4f17-80f4-e6400c861792",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6690a459-3001-4c74-8448-907ca2178876",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4aabff33-40f1-4a2c-b795-fc8a7aad337a",
"db_currency_id": "8f1f30a5-876f-45cc-9a19-289d0d971817",
"db_language_id": "c227489e-6f02-40d5-ba25-f36ec4da907d",
"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-11-12T07:17:44.9031192+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-12T07:17:44.9031192+00:00"
},
"company_id": "e964422e-1607-4db5-b076-71c4af090059",
"company_code": "sample string 12",
"db_address_id": "fe5d87cf-7cd8-4b60-b753-0b4510ecbe70",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "72c10e62-f1d3-4e98-9390-17ab1b2085e9",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "cbaf5393-0189-4112-81b9-158c59df968d",
"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-11-12T07:17:44.9031192+00:00",
"date_create": "2025-11-12T07:17:44.9031192+00:00",
"date_update": "2025-11-12T07:17:44.9031192+00:00",
"updated_by_user_id": "0d9fe0c5-6696-4daf-9c0b-de22355ea3e2",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-12T07:17:44.9031192+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-11-12T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-11-12T07:17:44.9031192+00:00",
"date_last_job": "2025-11-12T07:17:44.9031192+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-12T07:17:44.9031192+00:00",
"modified_dateutc": "2025-11-12T07:17:44.9031192+00:00",
"is_mobile_installation": true
},
"job_type_id": "f15dffe4-c3ef-40b9-9480-3f9e821a9e07",
"job_type_code": "sample string 7",
"job_type": {
"id": "fdceb491-7c6e-41b2-b46c-b4a454d29a3d",
"name": "sample string 2",
"sales_organization_id": "8407c078-fe49-4c3e-9b86-1f7cdb14c048",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-12T07:17:44.9031192+00:00",
"code": "sample string 7"
},
"job_priority_id": "fe4f1aa7-32b2-48e6-8c30-12045ff11ad0",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "e75df885-304a-45bf-aa17-f2afa6758ab7",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "0b825ede-c83c-4e25-ac0d-31050d181f11",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6690a459-3001-4c74-8448-907ca2178876",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4aabff33-40f1-4a2c-b795-fc8a7aad337a",
"db_currency_id": "8f1f30a5-876f-45cc-9a19-289d0d971817",
"db_language_id": "c227489e-6f02-40d5-ba25-f36ec4da907d",
"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-11-12T07:17:44.9031192+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-12T07:17:44.9031192+00:00"
},
"job_status_id": "8aadefed-05ef-45c2-a480-0efdcf6f0449",
"job_status_code": "sample string 11",
"db_address_id": "41e4adcc-50ab-4b08-9648-fc8c1ab11e12",
"contact_id": "620e1b2a-efbc-41a6-ae02-1d050dc6b356",
"requested_by_company_id": "0fef8afc-2ba6-44f5-bd07-4a56fdd4b963",
"requested_by_contact_id": "57703be7-dd78-4cc8-b107-61c1cb50566e",
"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-11-12T07:17:44.9031192+00:00",
"due_date": "2025-11-12T07:17:44.9031192+00:00",
"date_create": "2025-11-12T07:17:44.9031192+00:00",
"date_update": "2025-11-12T07:17:44.9031192+00:00",
"date_closed": "2025-11-12T07:17:44.9031192+00:00",
"suggested_user_id": "4a1e1a16-f83f-4f1d-8970-d5353202d835",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "0f9c260b-43b7-44af-b81d-20f43c30b118",
"db_language_id": "ed2aeef6-c11f-4d12-b07a-1191e46575ca",
"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-11-12T07:17:44.9031192+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "0357e96a-af6e-4df8-a5d1-22f06e020063",
"sales_organization": {
"id": "6690a459-3001-4c74-8448-907ca2178876",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4aabff33-40f1-4a2c-b795-fc8a7aad337a",
"db_currency_id": "8f1f30a5-876f-45cc-9a19-289d0d971817",
"db_language_id": "c227489e-6f02-40d5-ba25-f36ec4da907d",
"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-11-12T07:17:44.9031192+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "67a0b49b-24ee-4a14-b885-8d2056fe1c52",
"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": "45b98012-15c3-4630-8ab0-d35ff69049a8",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-12T07:17:44.9031192+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "6bfc8e7b-8314-4024-b21b-01368b9703ba"
},
"suggested_date_start": "2025-11-12T07:17:44.9031192+00:00",
"skill_id": "50a468ca-a895-4611-88ae-1b3c6dd8773f",
"skill_code": "sample string 32",
"skill": {
"id": "246a04b4-cc87-4bcc-8fd9-022172770f9f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "826d04e5-c0c1-4480-9bce-c7e7a2a6fde7",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6690a459-3001-4c74-8448-907ca2178876",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4aabff33-40f1-4a2c-b795-fc8a7aad337a",
"db_currency_id": "8f1f30a5-876f-45cc-9a19-289d0d971817",
"db_language_id": "c227489e-6f02-40d5-ba25-f36ec4da907d",
"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-11-12T07:17:44.9031192+00:00"
},
"modified_dateutc": "2025-11-12T07:17:44.9031192+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "defcdade-45e4-4fbb-96f3-495939342e6d",
"date_reported_by_company": "2025-11-12T07:17:44.9031192+00:00",
"id2": 36,
"company_id": "c8c44b20-0375-4a6d-9cde-4805043695e9",
"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": "749a07d5-fa57-4168-924b-ef982312909c",
"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-11-12T07:17:44.9031192+00:00"
},
"work_instruction_details_id": "09354da6-f407-4adf-810a-61b98f6ab325",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "60352c30-6a3d-4298-9b8e-e0bc76593b9d",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "56fc92a1-f975-4ce8-9768-1f57f6d4f029",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-11-12T07:17:44.9031192+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": "3a1c0a4d-6a74-40d1-8c72-a382d5c4279f",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-11-12T07:17:44.9031192+00:00"
}