Retrieves all the job work instruction list.
Request Information
URI Parameters :
None.
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": "a87f97f1-862f-4dff-93f0-ecc0db3e00f9",
"jobs_id": "2659bf17-a544-44fa-8963-53e4e2758ece",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "95e1f032-1e0b-406d-912f-0e2c08c43d8c",
"_parent_id": "dc0c35fb-7d61-4c5e-80d2-318aabdc87b6",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "3563978f-5800-48fe-b7c9-5d70057b8722",
"project_reference_back_office": "sample string 5",
"project": {
"id": "b4db8d4f-1fdd-4a0d-b9ae-2b1c92a9cdf8",
"_parent_id": "ef554757-dda8-4756-8f45-0b186bebfdf0",
"root_parent_id": "c60f5d21-1b70-4fd0-89f0-477fcd9f6450",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "5cb63237-1010-456a-bdc1-408e1ea09f29",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "dd4d5aec-fa58-42da-aeb3-a52216eb83b1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c165e02b-190b-49c1-8005-54deecfb5fe9",
"_parent_code": "sample string 6",
"sales_organization_id": "9cf45d20-1487-424a-863c-494c7136ace8",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "838d3447-d6ee-4c26-8565-b77f790e84b0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0f0bbdca-fe06-4a95-8713-f29b13edb50a",
"db_currency_id": "80e99845-53e2-429d-ab05-98566020098a",
"db_language_id": "19cd5951-f012-49b0-bc77-26e5ef047c0e",
"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-09-23T08:39:13.1165779+00:00"
},
"modified_dateutc": "2026-09-23T08:39:13.1165779+00:00"
},
"equipment_model_id": "f0f8e342-560e-416d-ae75-c018ccafd4f9",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "07710347-2e30-4c9e-a1e8-42fe2fdb785a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "08f73718-2af1-4a73-bf25-38bbfafe67b7",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "3ad8b504-f0d6-445b-9a20-14d5c82043f3",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "d8404ae3-2e0c-4a77-882f-892c54f2240d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "838d3447-d6ee-4c26-8565-b77f790e84b0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0f0bbdca-fe06-4a95-8713-f29b13edb50a",
"db_currency_id": "80e99845-53e2-429d-ab05-98566020098a",
"db_language_id": "19cd5951-f012-49b0-bc77-26e5ef047c0e",
"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-09-23T08:39:13.1165779+00:00"
},
"modified_dateutc": "2026-09-23T08:39:13.1165779+00:00"
},
"equipment_family_id": "183a2378-2878-4964-bcc3-95a662ca9989",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "dd4d5aec-fa58-42da-aeb3-a52216eb83b1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c165e02b-190b-49c1-8005-54deecfb5fe9",
"_parent_code": "sample string 6",
"sales_organization_id": "9cf45d20-1487-424a-863c-494c7136ace8",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "838d3447-d6ee-4c26-8565-b77f790e84b0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0f0bbdca-fe06-4a95-8713-f29b13edb50a",
"db_currency_id": "80e99845-53e2-429d-ab05-98566020098a",
"db_language_id": "19cd5951-f012-49b0-bc77-26e5ef047c0e",
"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-09-23T08:39:13.1165779+00:00"
},
"modified_dateutc": "2026-09-23T08:39:13.1165779+00:00"
},
"date_in_production_since": "2026-09-23T08:39:13.1165779+00:00",
"date_out_of_production_since": "2026-09-23T08:39:13.1165779+00:00",
"date_end_support": "2026-09-23T08:39:13.1165779+00:00",
"sales_organization_id": "b03c7594-f9b6-45ce-a417-b91bec97592f",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "838d3447-d6ee-4c26-8565-b77f790e84b0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0f0bbdca-fe06-4a95-8713-f29b13edb50a",
"db_currency_id": "80e99845-53e2-429d-ab05-98566020098a",
"db_language_id": "19cd5951-f012-49b0-bc77-26e5ef047c0e",
"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-09-23T08:39:13.1165779+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-09-23T08:39:13.1165779+00:00"
},
"project_status_id": "9db01a14-9954-4327-96e4-6c161d7e27ff",
"project_status_code": "sample string 10",
"project_status": {
"id": "13becf48-aeca-47f1-8bfd-bfa391af574d",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "815fef6a-2bc3-45e4-a736-983f1cd5edc9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "838d3447-d6ee-4c26-8565-b77f790e84b0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0f0bbdca-fe06-4a95-8713-f29b13edb50a",
"db_currency_id": "80e99845-53e2-429d-ab05-98566020098a",
"db_language_id": "19cd5951-f012-49b0-bc77-26e5ef047c0e",
"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-09-23T08:39:13.1165779+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-23T08:39:13.1165779+00:00"
},
"company_id": "ee6f388f-2467-4467-89a0-96f87bf7f048",
"company_code": "sample string 12",
"db_address_id": "9b82ecfd-9b3d-44b5-ab7b-661448c34d85",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "f88cbc6f-660c-4135-bce1-c8becf82e270",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "9840083f-e205-4a3d-9955-760ed5a4fad9",
"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-09-23T08:39:13.1165779+00:00",
"date_create": "2026-09-23T08:39:13.1165779+00:00",
"date_update": "2026-09-23T08:39:13.1165779+00:00",
"updated_by_user_id": "3502f5da-9ede-4406-bbf6-54ceb3a8a724",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-23T08:39:13.1165779+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-09-23T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-23T08:39:13.1165779+00:00",
"date_last_job": "2026-09-23T08:39:13.1165779+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-23T08:39:13.1165779+00:00",
"modified_dateutc": "2026-09-23T08:39:13.1165779+00:00",
"is_mobile_installation": true
},
"job_type_id": "d56d4367-4869-4189-98a7-e47c7b5a4bc1",
"job_type_code": "sample string 7",
"job_type": {
"id": "e3e3fd50-61c3-40bf-bf58-dd5c142adbe2",
"name": "sample string 2",
"sales_organization_id": "f4d6fc3e-7903-4f72-b242-c1ab36bf3ed9",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-23T08:39:13.1165779+00:00",
"code": "sample string 7"
},
"job_priority_id": "4ee26b24-89ca-4aa6-bbc4-03b416aded8a",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "c4096a01-3b3e-4bcd-9d3e-37f6efbff5fe",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "45ae0f9d-1ed9-4885-afc9-7e9c8ccbf2c1",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "838d3447-d6ee-4c26-8565-b77f790e84b0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0f0bbdca-fe06-4a95-8713-f29b13edb50a",
"db_currency_id": "80e99845-53e2-429d-ab05-98566020098a",
"db_language_id": "19cd5951-f012-49b0-bc77-26e5ef047c0e",
"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-09-23T08:39:13.1165779+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-23T08:39:13.1165779+00:00"
},
"job_status_id": "83ff90a8-e787-4ad8-a671-75ef3a7553fa",
"job_status_code": "sample string 11",
"db_address_id": "51ea7c82-025b-4b29-898b-4c06cbdc5a9b",
"contact_id": "dca9c6f8-1395-4b6c-9ba9-5a38a0811742",
"requested_by_company_id": "651c5c8a-f560-4216-b32a-c5f9312edc5b",
"requested_by_contact_id": "0845c04d-98e5-4b20-822c-7600d15fe682",
"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-09-23T08:39:13.1165779+00:00",
"due_date": "2026-09-23T08:39:13.1165779+00:00",
"date_create": "2026-09-23T08:39:13.1165779+00:00",
"date_update": "2026-09-23T08:39:13.1165779+00:00",
"date_closed": "2026-09-23T08:39:13.1165779+00:00",
"suggested_user_id": "ee2c4038-46a1-4245-82a8-7c492acee9d9",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "e225fad1-4db3-4191-9304-92a374529be7",
"db_language_id": "ccacf980-1c85-4a51-9795-17016bfbbf30",
"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-09-23T08:39:13.1165779+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "35648406-1c3d-46b9-b656-caf0a1ff9761",
"sales_organization": {
"id": "838d3447-d6ee-4c26-8565-b77f790e84b0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0f0bbdca-fe06-4a95-8713-f29b13edb50a",
"db_currency_id": "80e99845-53e2-429d-ab05-98566020098a",
"db_language_id": "19cd5951-f012-49b0-bc77-26e5ef047c0e",
"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-09-23T08:39:13.1165779+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "b33f735b-aef3-401e-b8f2-3952faa2ece6",
"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": "d20ee053-51eb-499c-a826-ff54ad67fbdd",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-23T08:39:13.1321994+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "66320a2f-99d4-4768-938a-7a39c4946350"
},
"suggested_date_start": "2026-09-23T08:39:13.1321994+00:00",
"skill_id": "13de7824-dff4-4eaf-8f4d-ad106496b25a",
"skill_code": "sample string 32",
"skill": {
"id": "e47df4a9-6189-4fe2-813f-0d93ce65f954",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "dc934ec6-b3cc-40f6-a420-66ee7f4f3c2f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "838d3447-d6ee-4c26-8565-b77f790e84b0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0f0bbdca-fe06-4a95-8713-f29b13edb50a",
"db_currency_id": "80e99845-53e2-429d-ab05-98566020098a",
"db_language_id": "19cd5951-f012-49b0-bc77-26e5ef047c0e",
"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-09-23T08:39:13.1165779+00:00"
},
"modified_dateutc": "2026-09-23T08:39:13.1321994+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "66d9ef37-8d9a-4b42-8e78-f31a521e0f6c",
"date_reported_by_company": "2026-09-23T08:39:13.1321994+00:00",
"id2": 36,
"company_id": "213c6429-e40e-47ef-924f-631748a61abe",
"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": "5c4416fd-03e0-4e68-abbd-35c68e9a3ba8",
"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-09-23T08:39:13.1321994+00:00"
},
"work_instruction_details_id": "60dcf99e-389a-4c2a-8c9a-1b9ed63c7e4f",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "9937552a-7a6e-4747-bbeb-dd1f4ec64de8",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "54739873-602b-454b-b17e-3411631aae4b",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-23T08:39:13.1321994+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": "a5f7e066-7e52-4e5c-b5ee-22e495a37607",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-23T08:39:13.1321994+00:00"
}