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": "e1d773cd-0489-4c4e-b875-8f0046f58abe",
"jobs_id": "4ef514ff-3523-4cb7-ab1f-9362b858adff",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "198d79c1-892e-4392-8dc6-beaf0c4fec99",
"_parent_id": "d9f76683-018d-4a56-8700-db31c8a43bff",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "ce324a38-f2d0-414e-8e21-991310849917",
"project_reference_back_office": "sample string 5",
"project": {
"id": "dde8589e-140b-4ac4-af9d-3c3228086f43",
"_parent_id": "db55f7c7-0c73-495b-842b-c4ca188232b2",
"root_parent_id": "89e480b9-ea35-4db1-a0cd-f9104bf5c8b5",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "d178c447-2531-4b2b-97d1-0071dac4f6d1",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "59723769-7599-4339-8796-2411e718a31f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a78ac4f2-4ed4-4429-b61b-61832aba89b7",
"_parent_code": "sample string 6",
"sales_organization_id": "21785614-89c5-4005-ab2a-b726e082383d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4f50bc5f-1adb-4796-8c84-58b1b700392e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5a6b00ae-aa0a-4233-84ed-74c31e1b280b",
"db_currency_id": "0908bf91-3b8b-4b9b-af40-6d3dd575515d",
"db_language_id": "fcbc6087-5df4-42b7-8352-8e9acea69ef4",
"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-03T18:07:42.3920896+00:00"
},
"modified_dateutc": "2026-04-03T18:07:42.3920896+00:00"
},
"equipment_model_id": "69701b4f-2d14-46e7-841f-31340bbaa2fe",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "842b3bd9-c1e8-4dca-8696-5d86c9470e24",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "fb06d0f8-faad-4727-9af2-837826fb3bd1",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "b8319517-236c-49fe-8198-24e75d18face",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "096047f0-d079-498e-aaac-5ae74916d693",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4f50bc5f-1adb-4796-8c84-58b1b700392e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5a6b00ae-aa0a-4233-84ed-74c31e1b280b",
"db_currency_id": "0908bf91-3b8b-4b9b-af40-6d3dd575515d",
"db_language_id": "fcbc6087-5df4-42b7-8352-8e9acea69ef4",
"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-03T18:07:42.3920896+00:00"
},
"modified_dateutc": "2026-04-03T18:07:42.3920896+00:00"
},
"equipment_family_id": "e808b177-40d5-49c6-a3ab-65a06c3f0501",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "59723769-7599-4339-8796-2411e718a31f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a78ac4f2-4ed4-4429-b61b-61832aba89b7",
"_parent_code": "sample string 6",
"sales_organization_id": "21785614-89c5-4005-ab2a-b726e082383d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4f50bc5f-1adb-4796-8c84-58b1b700392e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5a6b00ae-aa0a-4233-84ed-74c31e1b280b",
"db_currency_id": "0908bf91-3b8b-4b9b-af40-6d3dd575515d",
"db_language_id": "fcbc6087-5df4-42b7-8352-8e9acea69ef4",
"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-03T18:07:42.3920896+00:00"
},
"modified_dateutc": "2026-04-03T18:07:42.3920896+00:00"
},
"date_in_production_since": "2026-04-03T18:07:42.3920896+00:00",
"date_out_of_production_since": "2026-04-03T18:07:42.3920896+00:00",
"date_end_support": "2026-04-03T18:07:42.3920896+00:00",
"sales_organization_id": "ab7fbaca-3a05-4bf3-b375-78ca0b485d64",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "4f50bc5f-1adb-4796-8c84-58b1b700392e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5a6b00ae-aa0a-4233-84ed-74c31e1b280b",
"db_currency_id": "0908bf91-3b8b-4b9b-af40-6d3dd575515d",
"db_language_id": "fcbc6087-5df4-42b7-8352-8e9acea69ef4",
"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-03T18:07:42.3920896+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-03T18:07:42.3920896+00:00"
},
"project_status_id": "012f3dbb-81fe-4aca-8c4c-1029f67f2291",
"project_status_code": "sample string 10",
"project_status": {
"id": "d0ecd1a4-92d1-4096-a92a-f36af3ebd28b",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "ab208842-babe-4dce-9c81-d9eeee12b34b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4f50bc5f-1adb-4796-8c84-58b1b700392e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5a6b00ae-aa0a-4233-84ed-74c31e1b280b",
"db_currency_id": "0908bf91-3b8b-4b9b-af40-6d3dd575515d",
"db_language_id": "fcbc6087-5df4-42b7-8352-8e9acea69ef4",
"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-03T18:07:42.3920896+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-03T18:07:42.3920896+00:00"
},
"company_id": "34b5ee69-8a0b-4688-8ac0-39dc80275766",
"company_code": "sample string 12",
"db_address_id": "90be345d-2b80-4899-8b4a-cb66e43fe303",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "abebb48a-a73e-4871-bf46-13a85af05f62",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "73eb591c-fd3f-4477-acb8-32237da2c28b",
"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-03T18:07:42.3920896+00:00",
"date_create": "2026-04-03T18:07:42.3920896+00:00",
"date_update": "2026-04-03T18:07:42.3920896+00:00",
"updated_by_user_id": "3c510dc9-3889-4731-82a8-52185efaf062",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-04-03T18:07:42.3920896+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-03T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-04-03T18:07:42.3920896+00:00",
"date_last_job": "2026-04-03T18:07:42.3920896+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-04-03T18:07:42.3920896+00:00",
"modified_dateutc": "2026-04-03T18:07:42.3920896+00:00",
"is_mobile_installation": true
},
"job_type_id": "ab23e03d-42ef-442c-ba67-48dd8e1ba31b",
"job_type_code": "sample string 7",
"job_type": {
"id": "3ef24fc4-9f23-4c30-bd0b-d55662c7831a",
"name": "sample string 2",
"sales_organization_id": "c9768e45-0c94-437a-a4fb-1a1920fbf648",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-04-03T18:07:42.3920896+00:00",
"code": "sample string 7"
},
"job_priority_id": "9723d0ce-e5fa-4d95-9447-205334aa2f72",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "3810c1c9-365b-44c1-b61d-fe37a1b104f4",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "91488738-74b5-4cac-a14b-5ce9aeba3c83",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4f50bc5f-1adb-4796-8c84-58b1b700392e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5a6b00ae-aa0a-4233-84ed-74c31e1b280b",
"db_currency_id": "0908bf91-3b8b-4b9b-af40-6d3dd575515d",
"db_language_id": "fcbc6087-5df4-42b7-8352-8e9acea69ef4",
"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-03T18:07:42.3920896+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-03T18:07:42.3920896+00:00"
},
"job_status_id": "04740d7c-23af-446f-8bd7-743be44d4df4",
"job_status_code": "sample string 11",
"db_address_id": "94b8aa30-44c0-4152-af7b-1abdfea6030a",
"contact_id": "486975b7-64c7-479d-bca7-72e4ee51aad1",
"requested_by_company_id": "4242b79a-238e-45d4-9c59-268e6e63da77",
"requested_by_contact_id": "24e9528c-a4e4-4b56-afc9-195689df026f",
"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-03T18:07:42.3920896+00:00",
"due_date": "2026-04-03T18:07:42.3920896+00:00",
"date_create": "2026-04-03T18:07:42.3920896+00:00",
"date_update": "2026-04-03T18:07:42.3920896+00:00",
"date_closed": "2026-04-03T18:07:42.3920896+00:00",
"suggested_user_id": "38817a31-fb00-407c-97af-f3b89b1a0146",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "5ac25d24-79c0-4087-b1c6-b716aabe3abb",
"db_language_id": "8d7e7e55-3945-4121-b111-79ef569455f0",
"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-03T18:07:42.3920896+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "732e91e1-a908-4168-a493-00fd794cb430",
"sales_organization": {
"id": "4f50bc5f-1adb-4796-8c84-58b1b700392e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5a6b00ae-aa0a-4233-84ed-74c31e1b280b",
"db_currency_id": "0908bf91-3b8b-4b9b-af40-6d3dd575515d",
"db_language_id": "fcbc6087-5df4-42b7-8352-8e9acea69ef4",
"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-03T18:07:42.3920896+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "004f2ed5-0ba3-4aba-8f49-59ad21dc956b",
"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": "7ed4fc29-1f05-4f5d-b77f-ebdae6fdb7eb",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-04-03T18:07:42.3920896+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "e03679e0-7a0d-485e-99b7-2cb5bfba481d"
},
"suggested_date_start": "2026-04-03T18:07:42.3920896+00:00",
"skill_id": "d75a55f2-7c24-4a77-ad60-22821bb6393d",
"skill_code": "sample string 32",
"skill": {
"id": "901b02b2-a460-4304-ba78-deaf92a9bab1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "8fd32819-5963-4563-aa51-b5e745eef7ae",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4f50bc5f-1adb-4796-8c84-58b1b700392e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5a6b00ae-aa0a-4233-84ed-74c31e1b280b",
"db_currency_id": "0908bf91-3b8b-4b9b-af40-6d3dd575515d",
"db_language_id": "fcbc6087-5df4-42b7-8352-8e9acea69ef4",
"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-03T18:07:42.3920896+00:00"
},
"modified_dateutc": "2026-04-03T18:07:42.3920896+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "d8b2eba1-7eb4-4717-afb1-1355188f2d59",
"date_reported_by_company": "2026-04-03T18:07:42.3920896+00:00",
"id2": 36,
"company_id": "479fadef-9821-4b9c-a5c6-4d973266efd4",
"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": "dff2fec3-69db-4a1f-9582-269077685280",
"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-03T18:07:42.3920896+00:00"
},
"work_instruction_details_id": "52d02ad1-84c7-44b1-bf52-4f95b23d2678",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "f46f6669-e3d2-4e6f-a150-9148fd432a25",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "caad10b7-0ab3-4ae6-a666-66b288e0e5b3",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-04-03T18:07:42.3920896+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": "36d8423a-b57d-42df-b2b6-1891d377b08b",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-04-03T18:07:42.3920896+00:00"
}