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": "aa70556d-aa4d-40d1-9bbe-99e5ce9e481b",
"jobs_id": "486c5e20-ded6-4ad4-b34f-c9f8630a5d61",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "e25b0044-16e9-4db8-9505-ebeabe428712",
"_parent_id": "6b0319db-8b32-4912-be30-19d689ce0db1",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "ad12f47a-e5d2-4afa-892e-ea7651d29af8",
"project_reference_back_office": "sample string 5",
"project": {
"id": "25c2e374-d34e-4f8a-a75b-f28fcbf8ea4a",
"_parent_id": "4344db68-a529-4650-a1de-0d9fbfad76c3",
"root_parent_id": "4e89a564-6a60-4fdc-ba55-264d6c63bb71",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "ccbb29fc-de40-42d9-abbd-a3839d47a109",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "d0c53ba7-a46b-46a7-9ebf-0e84e9de3093",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "5d961dd1-8172-49c7-98bc-4cabcb9a8c7b",
"_parent_code": "sample string 6",
"sales_organization_id": "39f4ab87-0fb4-4c59-9b9c-c20e9521e741",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "692f2447-8c27-497a-94f8-7455cfe0c876",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f5b633d2-b52f-4d47-9171-895f51e0646f",
"db_currency_id": "e80b29aa-a740-4096-a737-e2f2c2639b31",
"db_language_id": "2fd1cd88-ba97-45c1-bcfb-1b0b6288cc25",
"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-11-02T05:05:39.7156504+00:00"
},
"modified_dateutc": "2026-11-02T05:05:39.7156504+00:00"
},
"equipment_model_id": "9fb8cc54-4294-483f-a837-a1024e488196",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "c2a0776a-4e9e-44be-a021-13ebabad9b10",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "f498d485-5ed2-432d-9c93-4b70605b778e",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "f980c7bb-a883-4f12-ad45-ac681b81e364",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "507234bc-edb2-44f7-8f14-1f51fe1a00ea",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "692f2447-8c27-497a-94f8-7455cfe0c876",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f5b633d2-b52f-4d47-9171-895f51e0646f",
"db_currency_id": "e80b29aa-a740-4096-a737-e2f2c2639b31",
"db_language_id": "2fd1cd88-ba97-45c1-bcfb-1b0b6288cc25",
"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-11-02T05:05:39.7156504+00:00"
},
"modified_dateutc": "2026-11-02T05:05:39.7345506+00:00"
},
"equipment_family_id": "05423b5f-f609-461d-af50-ff0fdf99fc6f",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "d0c53ba7-a46b-46a7-9ebf-0e84e9de3093",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "5d961dd1-8172-49c7-98bc-4cabcb9a8c7b",
"_parent_code": "sample string 6",
"sales_organization_id": "39f4ab87-0fb4-4c59-9b9c-c20e9521e741",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "692f2447-8c27-497a-94f8-7455cfe0c876",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f5b633d2-b52f-4d47-9171-895f51e0646f",
"db_currency_id": "e80b29aa-a740-4096-a737-e2f2c2639b31",
"db_language_id": "2fd1cd88-ba97-45c1-bcfb-1b0b6288cc25",
"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-11-02T05:05:39.7156504+00:00"
},
"modified_dateutc": "2026-11-02T05:05:39.7156504+00:00"
},
"date_in_production_since": "2026-11-02T05:05:39.7345506+00:00",
"date_out_of_production_since": "2026-11-02T05:05:39.7345506+00:00",
"date_end_support": "2026-11-02T05:05:39.7345506+00:00",
"sales_organization_id": "04c8f1b7-e445-4529-a9b6-bffaaee2d49b",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "692f2447-8c27-497a-94f8-7455cfe0c876",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f5b633d2-b52f-4d47-9171-895f51e0646f",
"db_currency_id": "e80b29aa-a740-4096-a737-e2f2c2639b31",
"db_language_id": "2fd1cd88-ba97-45c1-bcfb-1b0b6288cc25",
"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-11-02T05:05:39.7156504+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-11-02T05:05:39.7345506+00:00"
},
"project_status_id": "30081b8c-43a2-437c-9511-9a8b6918a6ca",
"project_status_code": "sample string 10",
"project_status": {
"id": "77a60cd7-8c5d-4d5e-a889-09486d80b17b",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "6b58827e-39e6-4982-9182-704b359c7e55",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "692f2447-8c27-497a-94f8-7455cfe0c876",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f5b633d2-b52f-4d47-9171-895f51e0646f",
"db_currency_id": "e80b29aa-a740-4096-a737-e2f2c2639b31",
"db_language_id": "2fd1cd88-ba97-45c1-bcfb-1b0b6288cc25",
"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-11-02T05:05:39.7156504+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-02T05:05:39.7345506+00:00"
},
"company_id": "7463def2-47b4-4746-a897-7c6fa4abbded",
"company_code": "sample string 12",
"db_address_id": "c495a695-de79-4394-ba43-a4f8e1e54eae",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "9dc9e008-f8e5-416a-9a09-b1ef4852be00",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "bb478773-13d2-49dc-a4c6-1a58639a30bb",
"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-11-02T05:05:39.7345506+00:00",
"date_create": "2026-11-02T05:05:39.7345506+00:00",
"date_update": "2026-11-02T05:05:39.7345506+00:00",
"updated_by_user_id": "9b00ce67-7524-4545-8e52-cfbc840faf71",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-11-02T05:05:39.7345506+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-11-02T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-11-02T05:05:39.7345506+00:00",
"date_last_job": "2026-11-02T05:05:39.7345506+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-11-02T05:05:39.7345506+00:00",
"modified_dateutc": "2026-11-02T05:05:39.7345506+00:00",
"is_mobile_installation": true
},
"job_type_id": "ad68ca2b-0a3f-4b51-9d72-b40806531879",
"job_type_code": "sample string 7",
"job_type": {
"id": "28fd6f91-24b3-45e9-a366-92e6c331b8a9",
"name": "sample string 2",
"sales_organization_id": "ccda17c7-a72d-446f-a0ed-eeeb2eebd6f0",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-11-02T05:05:39.7345506+00:00",
"code": "sample string 7"
},
"job_priority_id": "1df6c0e8-d929-4fb0-bab1-e0f6a8651420",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "12e5422e-6627-4e04-80cc-7a60209fe662",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "04aababc-6964-4096-bb3e-0635dda64795",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "692f2447-8c27-497a-94f8-7455cfe0c876",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f5b633d2-b52f-4d47-9171-895f51e0646f",
"db_currency_id": "e80b29aa-a740-4096-a737-e2f2c2639b31",
"db_language_id": "2fd1cd88-ba97-45c1-bcfb-1b0b6288cc25",
"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-11-02T05:05:39.7156504+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-02T05:05:39.7345506+00:00"
},
"job_status_id": "b64cdd17-3458-46a7-b1d8-18448629acf7",
"job_status_code": "sample string 11",
"db_address_id": "c11ecbe3-b571-4109-b2e6-d5ccfcb23790",
"contact_id": "3df2ac6e-4c2c-44f6-88e4-d8ae75e05722",
"requested_by_company_id": "876eab99-f4e7-480f-bb3c-d0a3dcdfa25e",
"requested_by_contact_id": "ffe8d564-8271-4e13-8f0c-c1571f686791",
"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-11-02T05:05:39.7345506+00:00",
"due_date": "2026-11-02T05:05:39.7345506+00:00",
"date_create": "2026-11-02T05:05:39.7345506+00:00",
"date_update": "2026-11-02T05:05:39.7345506+00:00",
"date_closed": "2026-11-02T05:05:39.7345506+00:00",
"suggested_user_id": "6d884ca9-4ff9-446f-8796-78bfc585fe00",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "8960a891-cdbb-4e12-b913-184fe109ef90",
"db_language_id": "91ed2d99-01d7-42dd-85dd-6c2854d607c1",
"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-11-02T05:05:39.7345506+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "ac6b1adc-2040-4f0f-a08f-23c273afd211",
"sales_organization": {
"id": "692f2447-8c27-497a-94f8-7455cfe0c876",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f5b633d2-b52f-4d47-9171-895f51e0646f",
"db_currency_id": "e80b29aa-a740-4096-a737-e2f2c2639b31",
"db_language_id": "2fd1cd88-ba97-45c1-bcfb-1b0b6288cc25",
"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-11-02T05:05:39.7156504+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "0825dd98-990c-49ae-a83b-efb3eb585acd",
"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": "9cb7fe0e-e837-4ee9-8dae-c958e2002556",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-11-02T05:05:39.7345506+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "2253d7a2-7bb7-4444-90fa-b33913054aad"
},
"suggested_date_start": "2026-11-02T05:05:39.7345506+00:00",
"skill_id": "289789f9-f78f-414c-89c2-3e22008b351a",
"skill_code": "sample string 32",
"skill": {
"id": "d02714ae-59ff-4b7a-86a1-7a5423e5b255",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "ac882b52-9efc-49ae-9782-76f750d2f9bd",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "692f2447-8c27-497a-94f8-7455cfe0c876",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f5b633d2-b52f-4d47-9171-895f51e0646f",
"db_currency_id": "e80b29aa-a740-4096-a737-e2f2c2639b31",
"db_language_id": "2fd1cd88-ba97-45c1-bcfb-1b0b6288cc25",
"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-11-02T05:05:39.7156504+00:00"
},
"modified_dateutc": "2026-11-02T05:05:39.7345506+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "57da1c2d-d961-416c-918b-b613831b580a",
"date_reported_by_company": "2026-11-02T05:05:39.7345506+00:00",
"id2": 36,
"company_id": "614183a5-e88b-4610-9fc9-0b044b2aa569",
"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": "c7096f0a-d126-4c3c-bd74-49062af67b1e",
"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-11-02T05:05:39.7345506+00:00"
},
"work_instruction_details_id": "7aa29042-6fc6-45bf-8c42-eb6ab4ea204f",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "55f001ad-86be-4b56-b9eb-bd77571f1f05",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "ed376ca0-4346-4dca-8756-90c1038b1836",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-11-02T05:05:39.7345506+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": "4e907bbb-eded-4e59-9c11-7188695ab8f3",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-11-02T05:05:39.7345506+00:00"
}