Retrieves the job work instruction list with the specified key.
Request Information
URI Parameters :
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | globally unique identifier |
Required |
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": "7c5b38a2-1008-4f5f-a2b3-2a581a5c50cf",
"jobs_id": "fdecfd14-15a8-435d-82af-4460f6993346",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "ab1b68df-e81c-453f-b88d-595460e1f229",
"_parent_id": "7cf999e3-7478-4fd3-af6f-8a6fc5311d75",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "be961504-7eae-49cc-8407-fe6809603e35",
"project_reference_back_office": "sample string 5",
"project": {
"id": "aabdd480-7eda-40bd-853e-dbd1f7eeeea6",
"_parent_id": "ce2a9b75-31f0-4bb9-8928-7b93c7eabeb1",
"root_parent_id": "a3ef9bb9-7f55-4958-bd8a-d1c6be7712eb",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "076b8968-8802-42d3-bccd-ef5b864b4078",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "fb299a1f-4896-4cfb-9430-27bceb14f124",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "fa2508ce-12b0-4240-9cdd-887d3eeefec9",
"_parent_code": "sample string 6",
"sales_organization_id": "d5c859c2-0864-43c4-a00a-b4d6ca312a2e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "13aba432-9e83-42ce-bfb6-aa4ac4ba115e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f7e907ed-622e-4d4a-a72d-bc2dbcd717a6",
"db_currency_id": "72bd5efa-95a4-4fc8-8458-f21c8e3ad88b",
"db_language_id": "4e33dc4a-69f1-482f-8e43-d01418809a53",
"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-06-09T09:50:52.9607354+00:00"
},
"modified_dateutc": "2026-06-09T09:50:52.9607354+00:00"
},
"equipment_model_id": "d2f9da50-3f15-44c7-922c-a81740799ac4",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "7cbb56a4-8e2b-4714-9c98-02eb1b8e2ed6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "d86030bf-fadf-4a19-a2c2-3c97a270c3ea",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "45701005-e15a-4fd9-bae5-0f5988d106f4",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "b3a642c8-c4a9-47d1-86a9-b554551e4425",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "13aba432-9e83-42ce-bfb6-aa4ac4ba115e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f7e907ed-622e-4d4a-a72d-bc2dbcd717a6",
"db_currency_id": "72bd5efa-95a4-4fc8-8458-f21c8e3ad88b",
"db_language_id": "4e33dc4a-69f1-482f-8e43-d01418809a53",
"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-06-09T09:50:52.9607354+00:00"
},
"modified_dateutc": "2026-06-09T09:50:52.9607354+00:00"
},
"equipment_family_id": "e27ac7c5-250d-4415-9f67-932760d14c8a",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "fb299a1f-4896-4cfb-9430-27bceb14f124",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "fa2508ce-12b0-4240-9cdd-887d3eeefec9",
"_parent_code": "sample string 6",
"sales_organization_id": "d5c859c2-0864-43c4-a00a-b4d6ca312a2e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "13aba432-9e83-42ce-bfb6-aa4ac4ba115e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f7e907ed-622e-4d4a-a72d-bc2dbcd717a6",
"db_currency_id": "72bd5efa-95a4-4fc8-8458-f21c8e3ad88b",
"db_language_id": "4e33dc4a-69f1-482f-8e43-d01418809a53",
"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-06-09T09:50:52.9607354+00:00"
},
"modified_dateutc": "2026-06-09T09:50:52.9607354+00:00"
},
"date_in_production_since": "2026-06-09T09:50:52.9607354+00:00",
"date_out_of_production_since": "2026-06-09T09:50:52.9607354+00:00",
"date_end_support": "2026-06-09T09:50:52.9607354+00:00",
"sales_organization_id": "8304f780-6a99-4634-88c8-d0fc049cd163",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "13aba432-9e83-42ce-bfb6-aa4ac4ba115e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f7e907ed-622e-4d4a-a72d-bc2dbcd717a6",
"db_currency_id": "72bd5efa-95a4-4fc8-8458-f21c8e3ad88b",
"db_language_id": "4e33dc4a-69f1-482f-8e43-d01418809a53",
"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-06-09T09:50:52.9607354+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-06-09T09:50:52.9607354+00:00"
},
"project_status_id": "2dfafcae-895c-4a7f-bef8-772b12851175",
"project_status_code": "sample string 10",
"project_status": {
"id": "4e8d1d6c-ce67-4edc-bc12-eb620a875c11",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "6d50e351-de36-4fca-b79b-d0e9c44eadb7",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "13aba432-9e83-42ce-bfb6-aa4ac4ba115e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f7e907ed-622e-4d4a-a72d-bc2dbcd717a6",
"db_currency_id": "72bd5efa-95a4-4fc8-8458-f21c8e3ad88b",
"db_language_id": "4e33dc4a-69f1-482f-8e43-d01418809a53",
"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-06-09T09:50:52.9607354+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-09T09:50:52.9607354+00:00"
},
"company_id": "47e8b564-99f0-4ced-b420-c0e246b7f218",
"company_code": "sample string 12",
"db_address_id": "1048d47d-af90-468e-8542-55463c98be48",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "7e119685-f486-4aff-8958-972bd81c2779",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "760917af-4cca-4766-a07e-9ecc28fcb382",
"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-06-09T09:50:52.9607354+00:00",
"date_create": "2026-06-09T09:50:52.9607354+00:00",
"date_update": "2026-06-09T09:50:52.9607354+00:00",
"updated_by_user_id": "c3925a37-0a13-498d-b246-ba62f69ad1dc",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-09T09:50:52.9607354+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-06-09T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-09T09:50:52.9607354+00:00",
"date_last_job": "2026-06-09T09:50:52.9607354+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-09T09:50:52.9607354+00:00",
"modified_dateutc": "2026-06-09T09:50:52.9607354+00:00",
"is_mobile_installation": true
},
"job_type_id": "dc1ec905-996a-415b-b04a-c173a888fbd1",
"job_type_code": "sample string 7",
"job_type": {
"id": "2443cbf6-138a-458b-ab74-b17d9ad5f037",
"name": "sample string 2",
"sales_organization_id": "8ca38a2c-ac64-438a-a473-687da73e9f19",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-06-09T09:50:52.9607354+00:00",
"code": "sample string 7"
},
"job_priority_id": "fb7abcd7-01a2-4a32-bce0-bec06c04bd63",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "7357ef5f-e6aa-4f25-8451-86421f9bf6e6",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "8727abbe-3f15-4fa4-b6b2-e62510a03c5d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "13aba432-9e83-42ce-bfb6-aa4ac4ba115e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f7e907ed-622e-4d4a-a72d-bc2dbcd717a6",
"db_currency_id": "72bd5efa-95a4-4fc8-8458-f21c8e3ad88b",
"db_language_id": "4e33dc4a-69f1-482f-8e43-d01418809a53",
"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-06-09T09:50:52.9607354+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-09T09:50:52.9607354+00:00"
},
"job_status_id": "422c2a8d-483b-4741-8d7d-ae14e1599358",
"job_status_code": "sample string 11",
"db_address_id": "4a0745ca-7333-47e0-a8e0-8372675ea29f",
"contact_id": "a56ede60-0547-4676-9eaa-c8efd25010a2",
"requested_by_company_id": "75608666-8b7b-426b-8025-981724a347c7",
"requested_by_contact_id": "ce7e7188-36b4-4021-8725-f0862926c7dc",
"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-06-09T09:50:52.9607354+00:00",
"due_date": "2026-06-09T09:50:52.9607354+00:00",
"date_create": "2026-06-09T09:50:52.9607354+00:00",
"date_update": "2026-06-09T09:50:52.9607354+00:00",
"date_closed": "2026-06-09T09:50:52.9607354+00:00",
"suggested_user_id": "f2ef148f-c7a1-478c-bd3a-777f56f51996",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "81d3e718-26c3-46df-b913-0419a322b7c9",
"db_language_id": "a235eb4e-2ce0-48d8-ac87-88a2584cb1a1",
"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-06-09T09:50:52.9607354+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "cf2c5dc2-15c1-493d-a1e6-4cbbe73cb9bb",
"sales_organization": {
"id": "13aba432-9e83-42ce-bfb6-aa4ac4ba115e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f7e907ed-622e-4d4a-a72d-bc2dbcd717a6",
"db_currency_id": "72bd5efa-95a4-4fc8-8458-f21c8e3ad88b",
"db_language_id": "4e33dc4a-69f1-482f-8e43-d01418809a53",
"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-06-09T09:50:52.9607354+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "3dffb79e-cc6c-4e61-b32d-4fd65cba546b",
"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": "bd0fa4a6-5a5e-44b3-a84b-837e43ec5404",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-06-09T09:50:52.9607354+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "2c19c423-a472-4a9a-ae3b-840773ffc44d"
},
"suggested_date_start": "2026-06-09T09:50:52.9607354+00:00",
"skill_id": "5c5d34a3-7037-4746-9381-5aa252e29546",
"skill_code": "sample string 32",
"skill": {
"id": "71189edf-28f6-4635-9a5a-276dbf1f054a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "b9f62f48-7e39-412b-9a08-95da86604d52",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "13aba432-9e83-42ce-bfb6-aa4ac4ba115e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f7e907ed-622e-4d4a-a72d-bc2dbcd717a6",
"db_currency_id": "72bd5efa-95a4-4fc8-8458-f21c8e3ad88b",
"db_language_id": "4e33dc4a-69f1-482f-8e43-d01418809a53",
"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-06-09T09:50:52.9607354+00:00"
},
"modified_dateutc": "2026-06-09T09:50:52.9607354+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "c5022263-43a4-4088-8452-9e660dba1b89",
"date_reported_by_company": "2026-06-09T09:50:52.9607354+00:00",
"id2": 36,
"company_id": "aafac9f8-5b47-4170-b28e-79b76eeaef57",
"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": "7a8cc42a-a01e-4f65-ad2b-84ceaac4b47f",
"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-06-09T09:50:52.9607354+00:00"
},
"work_instruction_details_id": "b05d5d19-6747-424a-9654-ddf45806ae25",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "b3a81868-5c3a-4089-9f03-2da28f3e9e81",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "0f33d69d-fc28-4b93-835d-a847c061505f",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-06-09T09:50:52.9607354+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": "1e39393f-9dd5-4fa6-b76a-813199a7161b",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-06-09T09:50:52.9607354+00:00"
}