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": "37ade5f4-3e01-42ea-a7ab-b23fd893a67f",
"jobs_id": "268c2a29-508c-4f9c-9f69-7bca3048d1c8",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "414ee70a-f140-4e54-b1b2-485e2c64b562",
"_parent_id": "08a8e65f-9f12-4c89-9314-1252c3224463",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "8377c177-dae3-4fbd-8f3f-1c42d5a19f9a",
"project_reference_back_office": "sample string 5",
"project": {
"id": "4f9b2532-8857-4b7d-8529-474c798bd557",
"_parent_id": "303971cc-19af-40b8-9c52-b6eb2d4b9adf",
"root_parent_id": "fec00f4b-fdee-49c1-b787-bf998e6ad2fc",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "dbfc9ebe-a7ff-42e0-a0dc-02f19601c116",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "9536efb9-f2bb-4752-bbe3-cbe65613bdfa",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "5de38625-f6cd-4378-b3e6-83914042fa56",
"_parent_code": "sample string 6",
"sales_organization_id": "35df6122-738c-4175-a0b4-87502ba8caaf",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "69beaa2a-dab9-43a2-9c9a-7f6af62cccfc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3f15f462-08cd-45a7-afaf-45598c430288",
"db_currency_id": "b39e4652-b10a-44a2-9490-608a556d9c10",
"db_language_id": "77651842-fcd1-447e-b2c5-b7b1a32900a1",
"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-15T23:14:46.5837263+00:00"
},
"modified_dateutc": "2026-02-15T23:14:46.5837263+00:00"
},
"equipment_model_id": "868a95f7-7f53-4c19-9d62-7c230452394e",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "7faa5188-6f0c-42a8-bd32-c2c0107cd866",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "da3747c3-42d3-4639-8886-03649aae89b3",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "84a00302-2f8f-4d62-bb3d-3baa5bbf732a",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "9dd7fff6-e514-4132-9c7a-7cc6b8fa97f2",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "69beaa2a-dab9-43a2-9c9a-7f6af62cccfc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3f15f462-08cd-45a7-afaf-45598c430288",
"db_currency_id": "b39e4652-b10a-44a2-9490-608a556d9c10",
"db_language_id": "77651842-fcd1-447e-b2c5-b7b1a32900a1",
"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-15T23:14:46.5837263+00:00"
},
"modified_dateutc": "2026-02-15T23:14:46.5837263+00:00"
},
"equipment_family_id": "db763f5c-d29e-4586-b1a2-d7e77594c0c8",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "9536efb9-f2bb-4752-bbe3-cbe65613bdfa",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "5de38625-f6cd-4378-b3e6-83914042fa56",
"_parent_code": "sample string 6",
"sales_organization_id": "35df6122-738c-4175-a0b4-87502ba8caaf",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "69beaa2a-dab9-43a2-9c9a-7f6af62cccfc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3f15f462-08cd-45a7-afaf-45598c430288",
"db_currency_id": "b39e4652-b10a-44a2-9490-608a556d9c10",
"db_language_id": "77651842-fcd1-447e-b2c5-b7b1a32900a1",
"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-15T23:14:46.5837263+00:00"
},
"modified_dateutc": "2026-02-15T23:14:46.5837263+00:00"
},
"date_in_production_since": "2026-02-15T23:14:46.5837263+00:00",
"date_out_of_production_since": "2026-02-15T23:14:46.5837263+00:00",
"date_end_support": "2026-02-15T23:14:46.5837263+00:00",
"sales_organization_id": "a99a0f53-71ce-4d24-8ca7-509f6240017d",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "69beaa2a-dab9-43a2-9c9a-7f6af62cccfc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3f15f462-08cd-45a7-afaf-45598c430288",
"db_currency_id": "b39e4652-b10a-44a2-9490-608a556d9c10",
"db_language_id": "77651842-fcd1-447e-b2c5-b7b1a32900a1",
"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-15T23:14:46.5837263+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-15T23:14:46.5993533+00:00"
},
"project_status_id": "3e4d297f-5b00-44dd-8b7e-d43414d249a6",
"project_status_code": "sample string 10",
"project_status": {
"id": "01c8c1ab-19e4-4305-ae6c-ec464a4b7b95",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "e144d3e5-a31c-411c-b674-1699302be283",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "69beaa2a-dab9-43a2-9c9a-7f6af62cccfc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3f15f462-08cd-45a7-afaf-45598c430288",
"db_currency_id": "b39e4652-b10a-44a2-9490-608a556d9c10",
"db_language_id": "77651842-fcd1-447e-b2c5-b7b1a32900a1",
"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-15T23:14:46.5837263+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-15T23:14:46.5993533+00:00"
},
"company_id": "bbb8709d-b431-4196-9faa-292afb22eeed",
"company_code": "sample string 12",
"db_address_id": "76566341-63d5-47f6-bcfb-9ad887748f34",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "8b64c5e4-921c-4cf4-b78a-4636b6b61b9d",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "b22742f1-3607-450d-bcc4-4b0eedf0c666",
"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-15T23:14:46.5993533+00:00",
"date_create": "2026-02-15T23:14:46.5993533+00:00",
"date_update": "2026-02-15T23:14:46.5993533+00:00",
"updated_by_user_id": "7fcb2396-6a05-43a1-8154-e590c4da508e",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-02-15T23:14:46.5993533+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-15T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-02-15T23:14:46.5993533+00:00",
"date_last_job": "2026-02-15T23:14:46.5993533+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-02-15T23:14:46.5993533+00:00",
"modified_dateutc": "2026-02-15T23:14:46.5993533+00:00",
"is_mobile_installation": true
},
"job_type_id": "43dcab94-2cc8-4a75-943f-a90c74c38a99",
"job_type_code": "sample string 7",
"job_type": {
"id": "6e3c8b2e-2828-4dff-a53e-b02f2c53e997",
"name": "sample string 2",
"sales_organization_id": "e90e1fca-ef7e-4533-a274-e249e1fb37e7",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-02-15T23:14:46.5993533+00:00",
"code": "sample string 7"
},
"job_priority_id": "30453e83-8619-4e4c-9b7e-632335caeb27",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "748a4292-c07b-47b2-990d-4860fc5b5159",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "018d45b7-9527-4895-8bce-bf43ca877ab8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "69beaa2a-dab9-43a2-9c9a-7f6af62cccfc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3f15f462-08cd-45a7-afaf-45598c430288",
"db_currency_id": "b39e4652-b10a-44a2-9490-608a556d9c10",
"db_language_id": "77651842-fcd1-447e-b2c5-b7b1a32900a1",
"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-15T23:14:46.5837263+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-15T23:14:46.5993533+00:00"
},
"job_status_id": "1db5ed70-a5b6-4305-82e8-caaca1d7a5c5",
"job_status_code": "sample string 11",
"db_address_id": "c0aabd55-2e7b-4f0d-9e54-643bcd597d6b",
"contact_id": "1b7db747-041a-42df-a2d6-a9ae6ffbad85",
"requested_by_company_id": "22b74bae-7b09-43ef-a0a8-e4d000e88e55",
"requested_by_contact_id": "425d95db-41d1-43ef-9656-c6720d8cdf20",
"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-15T23:14:46.5993533+00:00",
"due_date": "2026-02-15T23:14:46.5993533+00:00",
"date_create": "2026-02-15T23:14:46.5993533+00:00",
"date_update": "2026-02-15T23:14:46.5993533+00:00",
"date_closed": "2026-02-15T23:14:46.5993533+00:00",
"suggested_user_id": "23b92bc4-5eb7-4e35-8280-935bfcf43194",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "095f260e-f506-4ea1-b86a-4331d1c0c30e",
"db_language_id": "d2bdf0d3-bd17-4935-bd31-717f28f53751",
"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-15T23:14:46.5993533+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "a41e09e4-e17f-4411-931f-9414a1302eff",
"sales_organization": {
"id": "69beaa2a-dab9-43a2-9c9a-7f6af62cccfc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3f15f462-08cd-45a7-afaf-45598c430288",
"db_currency_id": "b39e4652-b10a-44a2-9490-608a556d9c10",
"db_language_id": "77651842-fcd1-447e-b2c5-b7b1a32900a1",
"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-15T23:14:46.5837263+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "2a785c5f-a52f-42ed-83e3-adf29e333e7a",
"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": "599f60f6-b6bb-4da0-a8b7-a9acbe4d9e72",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-02-15T23:14:46.5993533+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "1886c2ec-58cc-4c82-ae65-c4a1af457ed3"
},
"suggested_date_start": "2026-02-15T23:14:46.5993533+00:00",
"skill_id": "afb12f1f-45be-4fc7-ac71-0b6629d2d9f4",
"skill_code": "sample string 32",
"skill": {
"id": "383fcb58-08d6-4454-8371-cb7a0309dc5f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "4b2cab71-f46a-4d5f-93a2-4f466684493e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "69beaa2a-dab9-43a2-9c9a-7f6af62cccfc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3f15f462-08cd-45a7-afaf-45598c430288",
"db_currency_id": "b39e4652-b10a-44a2-9490-608a556d9c10",
"db_language_id": "77651842-fcd1-447e-b2c5-b7b1a32900a1",
"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-15T23:14:46.5837263+00:00"
},
"modified_dateutc": "2026-02-15T23:14:46.5993533+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "78b96b3f-9642-44fd-9c60-928c591d06fa",
"date_reported_by_company": "2026-02-15T23:14:46.5993533+00:00",
"id2": 36,
"company_id": "3f2fc237-8d29-4237-9c3f-fddcd9fd370a",
"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": "ad2f9411-e982-4e01-a515-bc622d024f5c",
"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-15T23:14:46.5993533+00:00"
},
"work_instruction_details_id": "f8c6fb8a-97bf-4d3a-bfe1-8bc3ee961bb9",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "c0dc6cba-340f-43f6-953c-1bc8283cbf77",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "72d30fb9-2302-4dcf-98d4-a70c0eed2835",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-02-15T23:14:46.5993533+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": "bcf8343a-e058-4d4f-b370-d5f533411a56",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-02-15T23:14:46.5993533+00:00"
}