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": "2e821ced-d81f-45a4-a1e9-49f1647fb3a4",
"jobs_id": "23057fed-f9a8-4bfe-a8d3-c67a6c5ab43f",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "df7cebc5-cb51-4c2c-a3d3-022511f72811",
"_parent_id": "93024fdd-d81d-4a1d-a188-d7ba88355f8a",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "9628b998-06bc-4e0c-b2d2-69205a4fdc83",
"project_reference_back_office": "sample string 5",
"project": {
"id": "f5915632-4a93-49aa-b900-a9b29157df41",
"_parent_id": "22c45b54-f101-4e55-9ab1-b5246c3e0548",
"root_parent_id": "0611ae7d-6aaa-47d5-a3f5-3c7026838d67",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "5ab8853a-ab84-49a7-9f9e-d3b97165d426",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "45a188e7-844a-4042-8686-75e759905fb7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "dc457c1d-9a59-4e10-941e-a8741374d67e",
"_parent_code": "sample string 6",
"sales_organization_id": "9791e84e-bdc1-46d5-a09c-2518b3118d1a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "98451dc0-6013-4f59-b673-d96a53b393ca",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4abe2006-a5f5-4936-ad82-6e94505bf8c1",
"db_currency_id": "7c00f66b-03e9-4787-920b-e33f2efaef84",
"db_language_id": "25af0da1-8764-419e-88b4-8be494b7b693",
"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": "2025-11-19T21:37:54.1026022+00:00"
},
"modified_dateutc": "2025-11-19T21:37:54.1026022+00:00"
},
"equipment_model_id": "5dad5819-95ce-4417-b556-c7812cd4517d",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "e32cfd14-2912-462c-b554-8f16b3d01da4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "1287839c-e8cb-44c1-a426-a8ad69a6ebab",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "726ea12c-562b-4b95-b562-30368665a854",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "397816e5-6d1e-4dda-90d0-b8b248f9625d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "98451dc0-6013-4f59-b673-d96a53b393ca",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4abe2006-a5f5-4936-ad82-6e94505bf8c1",
"db_currency_id": "7c00f66b-03e9-4787-920b-e33f2efaef84",
"db_language_id": "25af0da1-8764-419e-88b4-8be494b7b693",
"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": "2025-11-19T21:37:54.1026022+00:00"
},
"modified_dateutc": "2025-11-19T21:37:54.1026022+00:00"
},
"equipment_family_id": "78ba0546-71a9-43ca-a1f3-e93eaad643a3",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "45a188e7-844a-4042-8686-75e759905fb7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "dc457c1d-9a59-4e10-941e-a8741374d67e",
"_parent_code": "sample string 6",
"sales_organization_id": "9791e84e-bdc1-46d5-a09c-2518b3118d1a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "98451dc0-6013-4f59-b673-d96a53b393ca",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4abe2006-a5f5-4936-ad82-6e94505bf8c1",
"db_currency_id": "7c00f66b-03e9-4787-920b-e33f2efaef84",
"db_language_id": "25af0da1-8764-419e-88b4-8be494b7b693",
"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": "2025-11-19T21:37:54.1026022+00:00"
},
"modified_dateutc": "2025-11-19T21:37:54.1026022+00:00"
},
"date_in_production_since": "2025-11-19T21:37:54.1026022+00:00",
"date_out_of_production_since": "2025-11-19T21:37:54.1026022+00:00",
"date_end_support": "2025-11-19T21:37:54.1026022+00:00",
"sales_organization_id": "647c1c7f-2544-4976-99a2-3c3ef19e9d79",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "98451dc0-6013-4f59-b673-d96a53b393ca",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4abe2006-a5f5-4936-ad82-6e94505bf8c1",
"db_currency_id": "7c00f66b-03e9-4787-920b-e33f2efaef84",
"db_language_id": "25af0da1-8764-419e-88b4-8be494b7b693",
"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": "2025-11-19T21:37:54.1026022+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": "2025-11-19T21:37:54.1026022+00:00"
},
"project_status_id": "c8fb7ce3-13bc-416d-8638-feeea9d41ac0",
"project_status_code": "sample string 10",
"project_status": {
"id": "2989b328-0697-4bf7-83e4-c28ba63a3d32",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "1715a045-3d58-421c-a1b7-52d478696ee3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "98451dc0-6013-4f59-b673-d96a53b393ca",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4abe2006-a5f5-4936-ad82-6e94505bf8c1",
"db_currency_id": "7c00f66b-03e9-4787-920b-e33f2efaef84",
"db_language_id": "25af0da1-8764-419e-88b4-8be494b7b693",
"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": "2025-11-19T21:37:54.1026022+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-19T21:37:54.1026022+00:00"
},
"company_id": "df8ed80e-489b-416f-926c-bdfe5648f9e4",
"company_code": "sample string 12",
"db_address_id": "f7cb37e5-ecfe-489d-8d28-816361c6c9ea",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "49de862a-84ab-4562-87fb-376c44e9fc0f",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "0eaa366d-220d-4c81-b0e0-b096760ac16a",
"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": "2025-11-19T21:37:54.1026022+00:00",
"date_create": "2025-11-19T21:37:54.1026022+00:00",
"date_update": "2025-11-19T21:37:54.1026022+00:00",
"updated_by_user_id": "3aaf7e19-afb1-4ee0-9657-c97d90edca6f",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-19T21:37:54.1026022+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": "2025-11-19T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-11-19T21:37:54.1026022+00:00",
"date_last_job": "2025-11-19T21:37:54.1026022+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-19T21:37:54.1026022+00:00",
"modified_dateutc": "2025-11-19T21:37:54.1026022+00:00",
"is_mobile_installation": true
},
"job_type_id": "564a9b87-852c-425a-b484-5eb4a3b279fb",
"job_type_code": "sample string 7",
"job_type": {
"id": "45b16a89-aea0-47ac-a600-2dd73f3913bd",
"name": "sample string 2",
"sales_organization_id": "465e3762-c091-4598-9856-378163c30062",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-19T21:37:54.1026022+00:00",
"code": "sample string 7"
},
"job_priority_id": "aefa98b5-81d1-4629-bc1d-462d72223c59",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "bb39cde0-5b00-4481-9921-a120dac8a884",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "e7e17e1f-b820-434e-99cd-80c318f33332",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "98451dc0-6013-4f59-b673-d96a53b393ca",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4abe2006-a5f5-4936-ad82-6e94505bf8c1",
"db_currency_id": "7c00f66b-03e9-4787-920b-e33f2efaef84",
"db_language_id": "25af0da1-8764-419e-88b4-8be494b7b693",
"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": "2025-11-19T21:37:54.1026022+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-19T21:37:54.1026022+00:00"
},
"job_status_id": "0fbfe858-4f86-4c63-ab6c-71b987e8a962",
"job_status_code": "sample string 11",
"db_address_id": "9ec426dc-e3f4-40e6-9ce1-9514c9063637",
"contact_id": "36f766c1-f594-4b1e-ae6c-26fd93062221",
"requested_by_company_id": "364c5374-6c48-490e-8e08-1f400c96bedf",
"requested_by_contact_id": "7910dafe-4f97-4a58-84d9-459bce606463",
"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": "2025-11-19T21:37:54.1026022+00:00",
"due_date": "2025-11-19T21:37:54.1026022+00:00",
"date_create": "2025-11-19T21:37:54.1026022+00:00",
"date_update": "2025-11-19T21:37:54.1026022+00:00",
"date_closed": "2025-11-19T21:37:54.1026022+00:00",
"suggested_user_id": "304c1fe3-ecf3-4407-8778-376f81826ec0",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "d86c8912-600f-43fc-a3fa-6b327013a8a0",
"db_language_id": "7f54ebae-8ed7-429a-b118-a101f6caa9d9",
"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": "2025-11-19T21:37:54.1026022+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "dc8b447f-5f83-4f72-a934-da4b20c3b441",
"sales_organization": {
"id": "98451dc0-6013-4f59-b673-d96a53b393ca",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4abe2006-a5f5-4936-ad82-6e94505bf8c1",
"db_currency_id": "7c00f66b-03e9-4787-920b-e33f2efaef84",
"db_language_id": "25af0da1-8764-419e-88b4-8be494b7b693",
"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": "2025-11-19T21:37:54.1026022+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "15617990-e966-4c79-a560-4b92995c862e",
"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": "04819652-4ce1-4d47-a4c1-4a2425b87650",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-19T21:37:54.1026022+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "e1b8e741-b3b1-4713-ac0e-199c494b9d65"
},
"suggested_date_start": "2025-11-19T21:37:54.1026022+00:00",
"skill_id": "fd26879c-1616-4679-99f4-5ae68c0e3b23",
"skill_code": "sample string 32",
"skill": {
"id": "1c3f1b60-960a-417e-8ed4-7ca92fdc0c19",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "79993385-ca05-42e3-8638-0fcff56bb9a1",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "98451dc0-6013-4f59-b673-d96a53b393ca",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4abe2006-a5f5-4936-ad82-6e94505bf8c1",
"db_currency_id": "7c00f66b-03e9-4787-920b-e33f2efaef84",
"db_language_id": "25af0da1-8764-419e-88b4-8be494b7b693",
"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": "2025-11-19T21:37:54.1026022+00:00"
},
"modified_dateutc": "2025-11-19T21:37:54.1026022+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "68dba2f4-0272-4e6f-8a46-8117cd3ba953",
"date_reported_by_company": "2025-11-19T21:37:54.1026022+00:00",
"id2": 36,
"company_id": "e89661f1-a4ad-4947-a101-5cce9edaad26",
"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": "3b043551-c1e7-4b9a-b95b-8a10d7e57825",
"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": "2025-11-19T21:37:54.1026022+00:00"
},
"work_instruction_details_id": "2b19da0c-4474-44af-9e24-ec03dbd8c9e1",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "eb07ecde-7f31-4888-9dce-882f0f13b22f",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "2dffd9b5-17fe-42c8-a41d-556e7ef473bf",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-11-19T21:37:54.1026022+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": "814ac3d1-550a-42af-aa45-f5e57c6753d3",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-11-19T21:37:54.1026022+00:00"
}