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": "5e72545e-a6a7-48e6-a0cd-22b8efbe4222",
"jobs_id": "165f9159-9d51-4c87-9e20-0c16999a74f6",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "acbe7601-93b6-4724-92cb-617bd103555e",
"_parent_id": "1c3df73c-c325-49b8-9583-361aea4a02f2",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "98180ba2-20e4-4b5f-bfc4-d9b41e8d516b",
"project_reference_back_office": "sample string 5",
"project": {
"id": "d0c7a82d-54a7-425f-8c7e-3a4652a8e9d9",
"_parent_id": "4972f955-4cc6-4fb1-81d5-bf46c50a05c9",
"root_parent_id": "d5e54824-7307-4301-b6c9-7dd08e9e2d20",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "7e49c903-33fa-4695-9a87-11dc0abebd0c",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "a3a12096-c283-425b-831c-8dff26fee19f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "db7c70e1-437c-4fa8-bbe1-ba6c2d30b9a8",
"_parent_code": "sample string 6",
"sales_organization_id": "130e8336-953b-4c9f-93a2-d46834dd4b5a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d9213fa0-ae72-43e2-a075-aaf351088d2b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ed8d612e-85ff-400a-b44c-3540dea0f1b6",
"db_currency_id": "086e4d7b-87ab-4347-9dc9-1e0212729043",
"db_language_id": "842188d8-0ce3-4955-b443-640538c0aaac",
"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-04-23T11:05:48.8887312+00:00"
},
"modified_dateutc": "2026-04-23T11:05:48.8887312+00:00"
},
"equipment_model_id": "5f4fee1c-8a75-4557-9044-14eb84f9653f",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "21e7d538-8b48-4fda-98e3-270ae5714017",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "49bf1807-ebd8-42f4-bad0-ed50037a118d",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "0fde84e1-648c-48b7-a9a6-b74dfbb1f416",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "60e0dc1d-d938-42a5-a11c-0cf4aa94a91f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d9213fa0-ae72-43e2-a075-aaf351088d2b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ed8d612e-85ff-400a-b44c-3540dea0f1b6",
"db_currency_id": "086e4d7b-87ab-4347-9dc9-1e0212729043",
"db_language_id": "842188d8-0ce3-4955-b443-640538c0aaac",
"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-04-23T11:05:48.8887312+00:00"
},
"modified_dateutc": "2026-04-23T11:05:48.8887312+00:00"
},
"equipment_family_id": "d4111308-d129-4b51-8887-ff44ea4208e3",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "a3a12096-c283-425b-831c-8dff26fee19f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "db7c70e1-437c-4fa8-bbe1-ba6c2d30b9a8",
"_parent_code": "sample string 6",
"sales_organization_id": "130e8336-953b-4c9f-93a2-d46834dd4b5a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d9213fa0-ae72-43e2-a075-aaf351088d2b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ed8d612e-85ff-400a-b44c-3540dea0f1b6",
"db_currency_id": "086e4d7b-87ab-4347-9dc9-1e0212729043",
"db_language_id": "842188d8-0ce3-4955-b443-640538c0aaac",
"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-04-23T11:05:48.8887312+00:00"
},
"modified_dateutc": "2026-04-23T11:05:48.8887312+00:00"
},
"date_in_production_since": "2026-04-23T11:05:48.8887312+00:00",
"date_out_of_production_since": "2026-04-23T11:05:48.8887312+00:00",
"date_end_support": "2026-04-23T11:05:48.8887312+00:00",
"sales_organization_id": "6895c172-c82e-45c8-a7e3-eb17533672c0",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "d9213fa0-ae72-43e2-a075-aaf351088d2b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ed8d612e-85ff-400a-b44c-3540dea0f1b6",
"db_currency_id": "086e4d7b-87ab-4347-9dc9-1e0212729043",
"db_language_id": "842188d8-0ce3-4955-b443-640538c0aaac",
"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-04-23T11:05:48.8887312+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-04-23T11:05:48.8887312+00:00"
},
"project_status_id": "ba4f8c6c-cb66-457a-a995-aa487d9324f5",
"project_status_code": "sample string 10",
"project_status": {
"id": "78d08775-2ace-4077-9f99-de3473ac7bf8",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "98b1db13-e122-4198-826b-f44136c61a13",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d9213fa0-ae72-43e2-a075-aaf351088d2b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ed8d612e-85ff-400a-b44c-3540dea0f1b6",
"db_currency_id": "086e4d7b-87ab-4347-9dc9-1e0212729043",
"db_language_id": "842188d8-0ce3-4955-b443-640538c0aaac",
"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-04-23T11:05:48.8887312+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-23T11:05:48.8887312+00:00"
},
"company_id": "f45f65e9-0d85-4995-b0ec-11e3606fbf6c",
"company_code": "sample string 12",
"db_address_id": "bfd34408-456d-43c2-937a-87b51b89046f",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "4eb2f62a-1ddc-457d-be44-a1e986342489",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "a19b26eb-48d6-4372-afdc-20ffe5b9a06a",
"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-04-23T11:05:48.8887312+00:00",
"date_create": "2026-04-23T11:05:48.8887312+00:00",
"date_update": "2026-04-23T11:05:48.8887312+00:00",
"updated_by_user_id": "dbe7d669-c7b8-4aec-b375-3644e42b84fc",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-04-23T11:05:48.8887312+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-04-23T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-04-23T11:05:48.8887312+00:00",
"date_last_job": "2026-04-23T11:05:48.8887312+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-04-23T11:05:48.8887312+00:00",
"modified_dateutc": "2026-04-23T11:05:48.8887312+00:00",
"is_mobile_installation": true
},
"job_type_id": "2a143086-12e9-4206-9322-8c063e3f8e50",
"job_type_code": "sample string 7",
"job_type": {
"id": "8409ac54-c809-477f-ad46-94f9a3dd9322",
"name": "sample string 2",
"sales_organization_id": "5755b610-6238-46ae-93de-5ed6a3af9521",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-04-23T11:05:48.8887312+00:00",
"code": "sample string 7"
},
"job_priority_id": "1f553fd6-d88c-4854-9173-d00a110c8abf",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "51b507d9-5863-44c4-8107-b44a77a17f42",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "bb980ad8-9dc3-410f-b8bf-45516029fa28",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d9213fa0-ae72-43e2-a075-aaf351088d2b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ed8d612e-85ff-400a-b44c-3540dea0f1b6",
"db_currency_id": "086e4d7b-87ab-4347-9dc9-1e0212729043",
"db_language_id": "842188d8-0ce3-4955-b443-640538c0aaac",
"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-04-23T11:05:48.8887312+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-23T11:05:48.8887312+00:00"
},
"job_status_id": "99c06ce4-7787-4782-93cc-b126a678c2e1",
"job_status_code": "sample string 11",
"db_address_id": "5222be2c-8517-4509-b9ff-556af15a157f",
"contact_id": "342044fb-848b-46b7-b936-9e6d61a0e1aa",
"requested_by_company_id": "12d43093-1e48-4ef4-992a-ef81424971a4",
"requested_by_contact_id": "147f7624-1dcc-48a4-b3f3-6b862348c4c7",
"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-04-23T11:05:48.8887312+00:00",
"due_date": "2026-04-23T11:05:48.8887312+00:00",
"date_create": "2026-04-23T11:05:48.8887312+00:00",
"date_update": "2026-04-23T11:05:48.8887312+00:00",
"date_closed": "2026-04-23T11:05:48.8887312+00:00",
"suggested_user_id": "4f06375a-31aa-4f7c-8658-d2066686703d",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "8bd089c7-438f-4272-960b-2ac0ac579c98",
"db_language_id": "55923d7e-9be2-4aa7-af8d-0423a0d365be",
"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-04-23T11:05:48.8887312+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "23973abb-39ae-4d36-9aab-25e5022e8b78",
"sales_organization": {
"id": "d9213fa0-ae72-43e2-a075-aaf351088d2b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ed8d612e-85ff-400a-b44c-3540dea0f1b6",
"db_currency_id": "086e4d7b-87ab-4347-9dc9-1e0212729043",
"db_language_id": "842188d8-0ce3-4955-b443-640538c0aaac",
"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-04-23T11:05:48.8887312+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "89bef1f8-0d44-45ac-86d4-2714c7b467a9",
"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": "76c78fe8-02ef-41cf-a478-97b0b3cc7027",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-04-23T11:05:48.8887312+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "16536c32-a871-4d15-aea7-9556c75ede5c"
},
"suggested_date_start": "2026-04-23T11:05:48.8887312+00:00",
"skill_id": "cb52358c-ad32-43e0-b8e9-fd6350ff0084",
"skill_code": "sample string 32",
"skill": {
"id": "fbb35043-172d-46f5-8110-954dd4aad94a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "e78be917-a2dc-4048-a2ce-a3894ffdf91d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d9213fa0-ae72-43e2-a075-aaf351088d2b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ed8d612e-85ff-400a-b44c-3540dea0f1b6",
"db_currency_id": "086e4d7b-87ab-4347-9dc9-1e0212729043",
"db_language_id": "842188d8-0ce3-4955-b443-640538c0aaac",
"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-04-23T11:05:48.8887312+00:00"
},
"modified_dateutc": "2026-04-23T11:05:48.8887312+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "9870c099-e9b5-434e-abbd-018ef1295561",
"date_reported_by_company": "2026-04-23T11:05:48.8887312+00:00",
"id2": 36,
"company_id": "5e63ad6e-fe74-47fa-ac82-c4564a3d70d8",
"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": "8e45f172-c383-4ccd-acd9-b2e3afa54df6",
"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-04-23T11:05:48.8887312+00:00"
},
"work_instruction_details_id": "d564a32b-c980-47f0-899e-23ed9958f5bc",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "085e9c03-119f-44e8-81f0-7790ce1ffaeb",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "74bb30a2-5bff-47c8-8b2c-9cbdca6b3971",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-04-23T11:05:48.8887312+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": "d72a4448-2fb0-4120-b515-aa5ea74cb66f",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-04-23T11:05:48.8887312+00:00"
}