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
{
"id": "b92912ca-461b-44f6-a503-4878028b7f21",
"jobs_id": "1297cdec-049b-4aed-b56f-0869021ac587",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "3aedaacd-faad-4a57-bbd0-3e0a8f0f4f51",
"_parent_id": "c93f191b-82c0-4ca9-bebd-ca860bb4cf7b",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "15af9bea-ffbf-45c9-868c-a366d4f74f74",
"project_reference_back_office": "sample string 5",
"project": {
"id": "190c3b2b-1868-4687-b2cc-b82deb5d2391",
"_parent_id": "0b2b67c8-db0d-4751-b3e2-2174e8535bf2",
"root_parent_id": "c8803624-7959-4106-bf44-85a1dc98e937",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "49391d5a-94a8-4e36-9530-afdd707a66a6",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "13d66d03-1215-4615-913a-424e485bc33d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "85a99154-271c-4276-9e53-71aed8feb972",
"_parent_code": "sample string 6",
"sales_organization_id": "de9fd1ec-0518-4620-a23e-70b2cde56c02",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d7dc59ce-55fd-42c1-865c-2a0121037ce1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "590fb82a-6aa6-4b00-b569-49c035c88697",
"db_currency_id": "ddc737f5-f4ca-4d74-a002-a298e1b8af5e",
"db_language_id": "61fefc81-5452-4f34-b55f-3692c201cdc8",
"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-11-19T18:09:46.3822986+00:00"
},
"modified_dateutc": "2026-11-19T18:09:46.3822986+00:00"
},
"equipment_model_id": "05fe19c1-1173-4cce-9230-337d437ba6cc",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "cca09d20-236b-4308-9c18-65ed2795a429",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "6f4ea212-6a5f-46e1-8a48-0cf14b488b1b",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "d65a6cc4-db41-41c3-ad1e-9843f33beb46",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "f4378cf3-d127-4738-b41b-704da9b89fbb",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d7dc59ce-55fd-42c1-865c-2a0121037ce1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "590fb82a-6aa6-4b00-b569-49c035c88697",
"db_currency_id": "ddc737f5-f4ca-4d74-a002-a298e1b8af5e",
"db_language_id": "61fefc81-5452-4f34-b55f-3692c201cdc8",
"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-11-19T18:09:46.3822986+00:00"
},
"modified_dateutc": "2026-11-19T18:09:46.3822986+00:00"
},
"equipment_family_id": "52bfcf05-67ff-4bac-87d2-b10d6ce7d913",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "13d66d03-1215-4615-913a-424e485bc33d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "85a99154-271c-4276-9e53-71aed8feb972",
"_parent_code": "sample string 6",
"sales_organization_id": "de9fd1ec-0518-4620-a23e-70b2cde56c02",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d7dc59ce-55fd-42c1-865c-2a0121037ce1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "590fb82a-6aa6-4b00-b569-49c035c88697",
"db_currency_id": "ddc737f5-f4ca-4d74-a002-a298e1b8af5e",
"db_language_id": "61fefc81-5452-4f34-b55f-3692c201cdc8",
"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-11-19T18:09:46.3822986+00:00"
},
"modified_dateutc": "2026-11-19T18:09:46.3822986+00:00"
},
"date_in_production_since": "2026-11-19T18:09:46.3822986+00:00",
"date_out_of_production_since": "2026-11-19T18:09:46.3822986+00:00",
"date_end_support": "2026-11-19T18:09:46.3822986+00:00",
"sales_organization_id": "ef9d30da-7bc9-4b53-a3c6-6bf1a6ca80f0",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "d7dc59ce-55fd-42c1-865c-2a0121037ce1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "590fb82a-6aa6-4b00-b569-49c035c88697",
"db_currency_id": "ddc737f5-f4ca-4d74-a002-a298e1b8af5e",
"db_language_id": "61fefc81-5452-4f34-b55f-3692c201cdc8",
"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-11-19T18:09:46.3822986+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-11-19T18:09:46.3822986+00:00"
},
"project_status_id": "13f13ccf-cc3a-4013-90dc-2095e23cfee1",
"project_status_code": "sample string 10",
"project_status": {
"id": "b61ce11b-670c-4937-ad72-5917213ef2fd",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "22677ea4-73ea-4794-84b8-6d8a02b4a445",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d7dc59ce-55fd-42c1-865c-2a0121037ce1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "590fb82a-6aa6-4b00-b569-49c035c88697",
"db_currency_id": "ddc737f5-f4ca-4d74-a002-a298e1b8af5e",
"db_language_id": "61fefc81-5452-4f34-b55f-3692c201cdc8",
"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-11-19T18:09:46.3822986+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-19T18:09:46.3822986+00:00"
},
"company_id": "6940528b-e4ff-4e90-b404-feb5e0da75f7",
"company_code": "sample string 12",
"db_address_id": "be9558c1-2361-4ca1-ae8d-89b4258a20fe",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "65ca6d9a-b7c6-4f73-856e-2f5b00de1530",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "636d679f-24df-419e-a361-a0e7525bcc9e",
"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-11-19T18:09:46.3822986+00:00",
"date_create": "2026-11-19T18:09:46.3822986+00:00",
"date_update": "2026-11-19T18:09:46.3822986+00:00",
"updated_by_user_id": "077b23db-bb6b-40d2-8a38-843e096607be",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-11-19T18:09:46.3822986+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-11-19T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-11-19T18:09:46.3822986+00:00",
"date_last_job": "2026-11-19T18:09:46.3822986+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-11-19T18:09:46.3822986+00:00",
"modified_dateutc": "2026-11-19T18:09:46.3822986+00:00",
"is_mobile_installation": true
},
"job_type_id": "1b983a87-333d-4377-aaf7-e238033390d3",
"job_type_code": "sample string 7",
"job_type": {
"id": "def374f4-6b51-4411-a712-eb4142cf9e6f",
"name": "sample string 2",
"sales_organization_id": "33f71aae-c05e-4342-b7df-6c3a8d527d29",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-11-19T18:09:46.3822986+00:00",
"code": "sample string 7"
},
"job_priority_id": "42dc0fe3-bbd9-43aa-87b7-1c8f90a143ff",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "610f364c-4900-486b-8cfe-8ca205af59a8",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "0c9ae304-396d-4ca6-9037-34cb6b7fbad5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d7dc59ce-55fd-42c1-865c-2a0121037ce1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "590fb82a-6aa6-4b00-b569-49c035c88697",
"db_currency_id": "ddc737f5-f4ca-4d74-a002-a298e1b8af5e",
"db_language_id": "61fefc81-5452-4f34-b55f-3692c201cdc8",
"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-11-19T18:09:46.3822986+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-19T18:09:46.3822986+00:00"
},
"job_status_id": "9d4f0b4a-3150-4952-8a58-28d3d3984fcf",
"job_status_code": "sample string 11",
"db_address_id": "6ac0555c-b2ee-4b2c-b678-3c6bd5454488",
"contact_id": "d4e5629d-1f86-4f34-a9bd-95a566e8e66a",
"requested_by_company_id": "3bef6924-7ce0-433c-9eb8-86731e400c63",
"requested_by_contact_id": "b357446b-69b9-44b3-a96f-892f130f9ea4",
"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-11-19T18:09:46.3822986+00:00",
"due_date": "2026-11-19T18:09:46.3822986+00:00",
"date_create": "2026-11-19T18:09:46.3822986+00:00",
"date_update": "2026-11-19T18:09:46.3822986+00:00",
"date_closed": "2026-11-19T18:09:46.3822986+00:00",
"suggested_user_id": "9fbad96e-3efc-41c4-9d17-cfa995cb0b0b",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "b2615010-8c1c-460c-8c2f-25c20e26a991",
"db_language_id": "925c0a7d-5c8f-4c50-af78-8722385a2b93",
"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-11-19T18:09:46.4022222+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "7a80d1ae-86e3-4fea-8b5c-32d1c94abbc5",
"sales_organization": {
"id": "d7dc59ce-55fd-42c1-865c-2a0121037ce1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "590fb82a-6aa6-4b00-b569-49c035c88697",
"db_currency_id": "ddc737f5-f4ca-4d74-a002-a298e1b8af5e",
"db_language_id": "61fefc81-5452-4f34-b55f-3692c201cdc8",
"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-11-19T18:09:46.3822986+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "f07f6494-98ea-4379-b390-b516867c80ca",
"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": "fdc2d72e-b2ba-4b42-8478-841400079faf",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-11-19T18:09:46.4022222+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "3fe9193c-4295-4669-930e-db4e63eb92ef"
},
"suggested_date_start": "2026-11-19T18:09:46.4022222+00:00",
"skill_id": "7dd4cb3c-6fa7-4cf9-9d91-8b3e7d68790d",
"skill_code": "sample string 32",
"skill": {
"id": "e6bce817-6f81-4224-b102-7b303b8a4c62",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "fba911de-cb8d-4f70-bd67-55413ff7d5a5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d7dc59ce-55fd-42c1-865c-2a0121037ce1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "590fb82a-6aa6-4b00-b569-49c035c88697",
"db_currency_id": "ddc737f5-f4ca-4d74-a002-a298e1b8af5e",
"db_language_id": "61fefc81-5452-4f34-b55f-3692c201cdc8",
"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-11-19T18:09:46.3822986+00:00"
},
"modified_dateutc": "2026-11-19T18:09:46.4022222+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "bf08ff87-05f9-4406-bb1f-c4580e8a0bcc",
"date_reported_by_company": "2026-11-19T18:09:46.4022222+00:00",
"id2": 36,
"company_id": "047f05b7-9af0-4bd6-8291-5ab25e17e037",
"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": "0c9da1dd-66ec-4ff4-9fcb-4dfe7a3c88a4",
"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-11-19T18:09:46.4022222+00:00"
},
"work_instruction_details_id": "20ca543f-bcf7-4221-9b0d-6b7543e9ac63",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "a20a353b-517f-475c-9294-66aca714dac2",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "5bbd8174-e987-431d-b731-cf71b3e4effb",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-11-19T18:09:46.4022222+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": "a14b286d-13e6-4696-8072-b77414160c79",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-11-19T18:09:46.4022222+00:00"
}