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": "3fff0196-b42f-4a1d-8abb-9205246ca87a",
"jobs_id": "14bef950-97ac-4e40-921d-ab4ea2c96ad9",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "a7794cdc-9a6d-4e01-be85-4eb2d8423d27",
"_parent_id": "793e3c0d-1620-40d3-b61d-7d00e2bcf69a",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "d5ffb09b-cd57-4c6d-bad5-6376099969a1",
"project_reference_back_office": "sample string 5",
"project": {
"id": "5a4b4bb8-4b3e-4ec7-951d-7442cf16a6bf",
"_parent_id": "c60f83c2-58d5-4d6b-8f17-41594feec8ae",
"root_parent_id": "0aece909-00c7-463e-82c5-37c0c3cadd20",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "238e836e-98ed-495a-b65e-d014d32fbd15",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "178afd76-8186-4678-993f-63218468d75b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "4e952919-221e-4be3-8849-6a62c012455b",
"_parent_code": "sample string 6",
"sales_organization_id": "54a9304a-99a0-4b56-9956-39c39424ae18",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b150d2e4-f10f-40e6-b6e6-788d440520b9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9eb0be47-343c-49db-a51a-5da8798c0fca",
"db_currency_id": "6ffdfa9d-260e-42b8-b016-7122f188ed8f",
"db_language_id": "c576f4b3-65da-4a7e-9da9-d5fbe935bcc8",
"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-02-01T14:43:18.1933089+00:00"
},
"modified_dateutc": "2026-02-01T14:43:18.1933089+00:00"
},
"equipment_model_id": "84603ed2-e3a4-462d-821d-9ba7f6dd46dc",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "24231540-e9a0-4a92-9845-2a94ec5455dd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "6023dd48-7103-43ac-93d6-ae5614aedf1a",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "d6d2e9d7-def7-4b12-b263-ba9c7b374d2d",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "eb515b45-9db9-4e30-b373-96bd0405a9e2",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b150d2e4-f10f-40e6-b6e6-788d440520b9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9eb0be47-343c-49db-a51a-5da8798c0fca",
"db_currency_id": "6ffdfa9d-260e-42b8-b016-7122f188ed8f",
"db_language_id": "c576f4b3-65da-4a7e-9da9-d5fbe935bcc8",
"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-02-01T14:43:18.1933089+00:00"
},
"modified_dateutc": "2026-02-01T14:43:18.1933089+00:00"
},
"equipment_family_id": "95973f0c-52d0-4a66-a1c8-b1a035c93038",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "178afd76-8186-4678-993f-63218468d75b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "4e952919-221e-4be3-8849-6a62c012455b",
"_parent_code": "sample string 6",
"sales_organization_id": "54a9304a-99a0-4b56-9956-39c39424ae18",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b150d2e4-f10f-40e6-b6e6-788d440520b9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9eb0be47-343c-49db-a51a-5da8798c0fca",
"db_currency_id": "6ffdfa9d-260e-42b8-b016-7122f188ed8f",
"db_language_id": "c576f4b3-65da-4a7e-9da9-d5fbe935bcc8",
"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-02-01T14:43:18.1933089+00:00"
},
"modified_dateutc": "2026-02-01T14:43:18.1933089+00:00"
},
"date_in_production_since": "2026-02-01T14:43:18.1933089+00:00",
"date_out_of_production_since": "2026-02-01T14:43:18.1933089+00:00",
"date_end_support": "2026-02-01T14:43:18.1933089+00:00",
"sales_organization_id": "865c39d1-2918-4cfb-a77c-c131907c4b12",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "b150d2e4-f10f-40e6-b6e6-788d440520b9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9eb0be47-343c-49db-a51a-5da8798c0fca",
"db_currency_id": "6ffdfa9d-260e-42b8-b016-7122f188ed8f",
"db_language_id": "c576f4b3-65da-4a7e-9da9-d5fbe935bcc8",
"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-02-01T14:43:18.1933089+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-02-01T14:43:18.1933089+00:00"
},
"project_status_id": "8c3b8b57-0499-4579-9981-9204c255f4cc",
"project_status_code": "sample string 10",
"project_status": {
"id": "f808b84a-d080-46c6-81ee-5c53f6ed2e7a",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "e4b85291-9ba0-490b-9d6a-6d2567a089ea",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b150d2e4-f10f-40e6-b6e6-788d440520b9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9eb0be47-343c-49db-a51a-5da8798c0fca",
"db_currency_id": "6ffdfa9d-260e-42b8-b016-7122f188ed8f",
"db_language_id": "c576f4b3-65da-4a7e-9da9-d5fbe935bcc8",
"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-02-01T14:43:18.1933089+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-01T14:43:18.1933089+00:00"
},
"company_id": "edc43a52-8995-442c-973b-a63e12091508",
"company_code": "sample string 12",
"db_address_id": "4b00db1d-3c22-47f7-9197-a2a55db2084a",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "3d4f2938-6ecd-492a-bdd2-c2488c22c301",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "2347f331-d4e9-494a-bceb-4d8594f2d0fa",
"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-02-01T14:43:18.1933089+00:00",
"date_create": "2026-02-01T14:43:18.1933089+00:00",
"date_update": "2026-02-01T14:43:18.1933089+00:00",
"updated_by_user_id": "808fb9dc-1580-4556-a5f0-0d30993eeac7",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-02-01T14:43:18.1933089+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-02-01T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-02-01T14:43:18.1933089+00:00",
"date_last_job": "2026-02-01T14:43:18.1933089+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-02-01T14:43:18.1933089+00:00",
"modified_dateutc": "2026-02-01T14:43:18.1933089+00:00",
"is_mobile_installation": true
},
"job_type_id": "5205f8ba-2878-4ec1-9a19-e961ad0240fa",
"job_type_code": "sample string 7",
"job_type": {
"id": "98dff2d1-160f-4786-9e38-6238e1918f77",
"name": "sample string 2",
"sales_organization_id": "c81f4bf7-6c77-454c-bc02-32c011ff6e0a",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-02-01T14:43:18.1933089+00:00",
"code": "sample string 7"
},
"job_priority_id": "afcc59fd-0d8d-49e5-bdee-7d9d85fff8fe",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "42a8ec48-fa99-4f3e-a5f2-3e658b893f07",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "98f79687-c404-46fb-a5da-05c0f966af9d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b150d2e4-f10f-40e6-b6e6-788d440520b9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9eb0be47-343c-49db-a51a-5da8798c0fca",
"db_currency_id": "6ffdfa9d-260e-42b8-b016-7122f188ed8f",
"db_language_id": "c576f4b3-65da-4a7e-9da9-d5fbe935bcc8",
"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-02-01T14:43:18.1933089+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-01T14:43:18.1933089+00:00"
},
"job_status_id": "fd6e0e9d-636b-401d-b0dd-7850669a19cd",
"job_status_code": "sample string 11",
"db_address_id": "49020a50-8a17-4616-8110-0f22a8e1d613",
"contact_id": "31e15297-1c5a-46a7-a9cc-e6a0e4282963",
"requested_by_company_id": "0b55eb6e-4094-4691-be4a-0e79b308f498",
"requested_by_contact_id": "5098cdcf-866a-45fd-9ae3-22413a311dbf",
"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-02-01T14:43:18.1933089+00:00",
"due_date": "2026-02-01T14:43:18.1933089+00:00",
"date_create": "2026-02-01T14:43:18.1933089+00:00",
"date_update": "2026-02-01T14:43:18.1933089+00:00",
"date_closed": "2026-02-01T14:43:18.1933089+00:00",
"suggested_user_id": "cbaef4c6-28f9-4f68-84d1-2d4eec6f331c",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "b2fe7d81-c648-4a6a-91e6-ded1e8b700ca",
"db_language_id": "1035055f-7c70-4f1b-a78c-2e9dfa25c22b",
"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-02-01T14:43:18.1933089+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "b45c0c1a-baa2-4c31-9d4f-a91f308100f5",
"sales_organization": {
"id": "b150d2e4-f10f-40e6-b6e6-788d440520b9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9eb0be47-343c-49db-a51a-5da8798c0fca",
"db_currency_id": "6ffdfa9d-260e-42b8-b016-7122f188ed8f",
"db_language_id": "c576f4b3-65da-4a7e-9da9-d5fbe935bcc8",
"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-02-01T14:43:18.1933089+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "09b1313f-8c2f-436a-909f-069bd1fa41ab",
"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": "e6b870c5-4954-48e3-9864-3de266ced96c",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-02-01T14:43:18.1933089+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "a73485d9-64b9-40de-b428-87cd4e0d3091"
},
"suggested_date_start": "2026-02-01T14:43:18.1933089+00:00",
"skill_id": "38c6995e-4f95-41b2-8aeb-9a41c0a494ba",
"skill_code": "sample string 32",
"skill": {
"id": "264f5b28-cc6b-427e-8150-d526d00d1160",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "689983d2-bd97-4ef2-93f8-5b7660de42d1",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b150d2e4-f10f-40e6-b6e6-788d440520b9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9eb0be47-343c-49db-a51a-5da8798c0fca",
"db_currency_id": "6ffdfa9d-260e-42b8-b016-7122f188ed8f",
"db_language_id": "c576f4b3-65da-4a7e-9da9-d5fbe935bcc8",
"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-02-01T14:43:18.1933089+00:00"
},
"modified_dateutc": "2026-02-01T14:43:18.1933089+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "9b13427d-3d3f-4613-871e-e847575f1275",
"date_reported_by_company": "2026-02-01T14:43:18.1933089+00:00",
"id2": 36,
"company_id": "b7895c4d-7702-454a-a881-d87fe8cee7fb",
"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": "ebcca47e-518b-4d62-b050-5c6763e73b16",
"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-02-01T14:43:18.1933089+00:00"
},
"work_instruction_details_id": "bfc95b1f-e162-46d7-b540-651afe67e84a",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "c8eabb9a-9daa-4b20-9585-9f8339676068",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "cb3c7a63-51ce-44a8-b791-ba37bad9ca8b",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-02-01T14:43:18.1933089+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": "b0748405-cd89-453a-a334-6a2c477a6217",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-02-01T14:43:18.1933089+00:00"
}