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": "198064c5-c2f9-4e9e-801a-c5356d60f42b",
"jobs_id": "45a6bc84-05ac-4370-9121-0561d0ef3d40",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "b02d8366-d447-4ebc-90d3-bf280a24e4eb",
"_parent_id": "3dbface5-9e6c-48eb-994b-1b3e90acdd86",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "325bbdb9-f2b1-407c-b963-9cc839e1a248",
"project_reference_back_office": "sample string 5",
"project": {
"id": "a7acd4b8-a65c-4ceb-a021-09e9133e8526",
"_parent_id": "c057fec4-05f4-4be1-8d9f-2dabc3becb17",
"root_parent_id": "fdb8098c-15fc-4754-9a09-ec7f0f9d8faf",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "ea11ffae-c906-4c18-bbd3-5fcbf988be50",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "18367e1e-d831-4ab2-83c3-3ae7ab2f826b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "11dd95ce-51ca-4543-b1aa-ffdcf4876f03",
"_parent_code": "sample string 6",
"sales_organization_id": "0938c071-1274-4316-881c-c550f0e15c92",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f4344460-1a63-4fc4-ae97-7bf670dc5aab",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b16e633d-4621-486f-b54e-191fcc1fe0b3",
"db_currency_id": "95517281-79bb-4c79-8422-178b0cfc0ef9",
"db_language_id": "b1e75dd3-3675-4a0b-8d21-3d4259d26b4c",
"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-07T22:43:16.3500612+00:00"
},
"modified_dateutc": "2025-06-07T22:43:16.3500612+00:00"
},
"equipment_model_id": "40c9281d-4004-4f34-8cae-5b611bf9f93f",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "2a6d4c38-9c6d-4011-a35f-cc1585e35c32",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "32b85e6f-d0b5-4003-bdde-9f5da2238b56",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "c702bfa7-5d48-452d-885f-4215c5029a3c",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "93dd6659-e402-4350-9e85-1d16d4df1b0b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f4344460-1a63-4fc4-ae97-7bf670dc5aab",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b16e633d-4621-486f-b54e-191fcc1fe0b3",
"db_currency_id": "95517281-79bb-4c79-8422-178b0cfc0ef9",
"db_language_id": "b1e75dd3-3675-4a0b-8d21-3d4259d26b4c",
"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-07T22:43:16.3500612+00:00"
},
"modified_dateutc": "2025-06-07T22:43:16.3500612+00:00"
},
"equipment_family_id": "d6cf38c2-823e-4a0b-bf0b-8ecf50bf6d83",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "18367e1e-d831-4ab2-83c3-3ae7ab2f826b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "11dd95ce-51ca-4543-b1aa-ffdcf4876f03",
"_parent_code": "sample string 6",
"sales_organization_id": "0938c071-1274-4316-881c-c550f0e15c92",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f4344460-1a63-4fc4-ae97-7bf670dc5aab",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b16e633d-4621-486f-b54e-191fcc1fe0b3",
"db_currency_id": "95517281-79bb-4c79-8422-178b0cfc0ef9",
"db_language_id": "b1e75dd3-3675-4a0b-8d21-3d4259d26b4c",
"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-07T22:43:16.3500612+00:00"
},
"modified_dateutc": "2025-06-07T22:43:16.3500612+00:00"
},
"date_in_production_since": "2025-06-07T22:43:16.3500612+00:00",
"date_out_of_production_since": "2025-06-07T22:43:16.3500612+00:00",
"date_end_support": "2025-06-07T22:43:16.3500612+00:00",
"sales_organization_id": "a46d9cb0-5936-420b-aeed-14faea37605e",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "f4344460-1a63-4fc4-ae97-7bf670dc5aab",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b16e633d-4621-486f-b54e-191fcc1fe0b3",
"db_currency_id": "95517281-79bb-4c79-8422-178b0cfc0ef9",
"db_language_id": "b1e75dd3-3675-4a0b-8d21-3d4259d26b4c",
"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-07T22:43:16.3500612+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-07T22:43:16.3500612+00:00"
},
"project_status_id": "2289ff06-485a-40aa-a785-12a81069cb9e",
"project_status_code": "sample string 10",
"project_status": {
"id": "672ce9b6-eb6d-4f8d-88cf-58b62774f9d0",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "1c19ba8d-06dc-4bbd-bd94-152bd9595637",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f4344460-1a63-4fc4-ae97-7bf670dc5aab",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b16e633d-4621-486f-b54e-191fcc1fe0b3",
"db_currency_id": "95517281-79bb-4c79-8422-178b0cfc0ef9",
"db_language_id": "b1e75dd3-3675-4a0b-8d21-3d4259d26b4c",
"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-07T22:43:16.3500612+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-06-07T22:43:16.3500612+00:00"
},
"company_id": "5cfde417-52f0-485c-a9ee-8d68b1dcd3ff",
"company_code": "sample string 12",
"db_address_id": "915a7c19-aff3-48cf-93e3-f7f77f48ec4d",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "5bf4db1d-98de-4670-9be6-4ee4d5657f6d",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "6eb89ace-eed7-45d5-b3a0-1e5a58c31a85",
"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-07T22:43:16.3500612+00:00",
"date_create": "2025-06-07T22:43:16.3500612+00:00",
"date_update": "2025-06-07T22:43:16.3500612+00:00",
"updated_by_user_id": "b696d1b1-c551-440b-b0bf-bed18b9e1326",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-06-07T22:43:16.3500612+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-07T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-06-07T22:43:16.3500612+00:00",
"date_last_job": "2025-06-07T22:43:16.3500612+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-06-07T22:43:16.3500612+00:00",
"modified_dateutc": "2025-06-07T22:43:16.3500612+00:00",
"is_mobile_installation": true
},
"job_type_id": "c36162ac-e852-49a1-8b63-b1a9b1e90250",
"job_type_code": "sample string 7",
"job_type": {
"id": "51db7cad-fad1-4c78-a5db-b20e38d1ac69",
"name": "sample string 2",
"sales_organization_id": "879b1ab4-93d3-42ea-a616-0c34a20c7c28",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-06-07T22:43:16.3500612+00:00",
"code": "sample string 7"
},
"job_priority_id": "8a3e3e8c-d98f-48d0-8137-2c5ea6c0839b",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "447bc47f-e124-43cc-b877-08e1e0cb1c22",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "16eddc94-4147-4936-82ec-4deb29043288",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f4344460-1a63-4fc4-ae97-7bf670dc5aab",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b16e633d-4621-486f-b54e-191fcc1fe0b3",
"db_currency_id": "95517281-79bb-4c79-8422-178b0cfc0ef9",
"db_language_id": "b1e75dd3-3675-4a0b-8d21-3d4259d26b4c",
"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-07T22:43:16.3500612+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-06-07T22:43:16.3500612+00:00"
},
"job_status_id": "6b3c7db2-9334-4453-9f5f-51d1bd28296c",
"job_status_code": "sample string 11",
"db_address_id": "6a3e8881-ec16-4981-8674-6de6b68c3336",
"contact_id": "f2913dd3-0c07-45e6-b1c0-945ca5436525",
"requested_by_company_id": "85db56f0-2e9b-4c87-a412-e45d1cc42bb6",
"requested_by_contact_id": "278380e2-dbfe-4507-b677-2d8ebdea340d",
"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-07T22:43:16.3500612+00:00",
"due_date": "2025-06-07T22:43:16.3500612+00:00",
"date_create": "2025-06-07T22:43:16.3500612+00:00",
"date_update": "2025-06-07T22:43:16.3500612+00:00",
"date_closed": "2025-06-07T22:43:16.3500612+00:00",
"suggested_user_id": "2eece09a-cb29-42d9-a150-c37d1e65c309",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "ec42ab9a-e925-4864-903a-82e42e19c1be",
"db_language_id": "9a0efb13-03b4-405f-a367-c3d47666e10b",
"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-07T22:43:16.3500612+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "751300e2-ae3a-4a6a-bee8-7bf5de21cd48",
"sales_organization": {
"id": "f4344460-1a63-4fc4-ae97-7bf670dc5aab",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b16e633d-4621-486f-b54e-191fcc1fe0b3",
"db_currency_id": "95517281-79bb-4c79-8422-178b0cfc0ef9",
"db_language_id": "b1e75dd3-3675-4a0b-8d21-3d4259d26b4c",
"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-07T22:43:16.3500612+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "ca7f769e-7a98-46d2-b347-a83a27a9f9b8",
"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": "888d7d3d-f23e-433f-be7a-0d00a5c080ca",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-06-07T22:43:16.3500612+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "e346e8e5-0ae3-4c3e-908a-82450937d0ff"
},
"suggested_date_start": "2025-06-07T22:43:16.3500612+00:00",
"skill_id": "ce6f3926-5496-4a1f-abe8-2709932183b7",
"skill_code": "sample string 32",
"skill": {
"id": "89b86d8d-bdef-4eff-b457-88c6ecd35b2e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "afd26679-611d-4e54-a481-1f6542017517",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f4344460-1a63-4fc4-ae97-7bf670dc5aab",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b16e633d-4621-486f-b54e-191fcc1fe0b3",
"db_currency_id": "95517281-79bb-4c79-8422-178b0cfc0ef9",
"db_language_id": "b1e75dd3-3675-4a0b-8d21-3d4259d26b4c",
"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-07T22:43:16.3500612+00:00"
},
"modified_dateutc": "2025-06-07T22:43:16.3500612+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "a41c7f8d-635b-4909-824a-31cffddd8491",
"date_reported_by_company": "2025-06-07T22:43:16.3500612+00:00",
"id2": 36,
"company_id": "e2aec355-74a5-4684-af9a-66df44c8cf24",
"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": "cf88f18e-8036-445d-9915-14ce93c8484a",
"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-07T22:43:16.3500612+00:00"
},
"work_instruction_details_id": "ead08d88-ee51-4e59-8714-7ef69d23070e",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "98d07291-830e-41c3-8711-30e1fee3345c",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "57510432-a71c-4e98-8ffd-f1396c29c3d0",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-06-07T22:43:16.3500612+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": "89ebcf86-04af-42e9-a30a-791a35204771",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-06-07T22:43:16.3500612+00:00"
}