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": "1f64afe7-5b3b-4473-b2ff-dbb13f704d98",
"jobs_id": "dd46622b-059c-418f-abc0-f9d8f20c19d2",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "e5a07be4-dcb8-4639-b3fc-525251e7b961",
"_parent_id": "70dddf26-8e99-4a42-b375-d826d2f20586",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "ced92177-483b-49a1-9ae4-1fb4029c73c9",
"project_reference_back_office": "sample string 5",
"project": {
"id": "76499e7a-081f-4a37-a8b6-1e98b709a4bc",
"_parent_id": "6792278f-3c66-49ad-9754-02e0adce834c",
"root_parent_id": "f595fb4c-3616-413c-8a85-44f1388ae1cc",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "9c23710c-ab11-4be8-982b-12aa08abc172",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "a4d62151-e700-479f-96ef-866281267277",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f2bbb626-5cb0-454e-908d-47e3f05c73d6",
"_parent_code": "sample string 6",
"sales_organization_id": "4a5c570d-5dd2-4b19-9b6e-c799f8cc7f37",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "88a5534b-5183-49f2-8b73-3c5c31d21e60",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e4db01a3-3621-4cea-be36-9d4d30cce8f3",
"db_currency_id": "42ccc89f-584e-4984-ab84-d786b4b91120",
"db_language_id": "77660625-563a-4078-8ca0-0c0138f9d97e",
"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-01-12T08:25:05.9486957+00:00"
},
"modified_dateutc": "2026-01-12T08:25:05.9486957+00:00"
},
"equipment_model_id": "06b5c8e0-4445-4da0-8a06-5766f4b9b00e",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "b54901ea-ce88-4b7b-8ec3-d6427b07d9d4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "2ec7e1b9-c162-4e32-a7f3-7ad4b4799a68",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "82cf2d61-4133-4480-bcc1-0aec03fc40f7",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "7104225f-bc26-4c03-8b9d-d9951c54785e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "88a5534b-5183-49f2-8b73-3c5c31d21e60",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e4db01a3-3621-4cea-be36-9d4d30cce8f3",
"db_currency_id": "42ccc89f-584e-4984-ab84-d786b4b91120",
"db_language_id": "77660625-563a-4078-8ca0-0c0138f9d97e",
"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-01-12T08:25:05.9486957+00:00"
},
"modified_dateutc": "2026-01-12T08:25:05.9486957+00:00"
},
"equipment_family_id": "aa57ec71-d99d-4599-9d04-12bccc4a066a",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "a4d62151-e700-479f-96ef-866281267277",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f2bbb626-5cb0-454e-908d-47e3f05c73d6",
"_parent_code": "sample string 6",
"sales_organization_id": "4a5c570d-5dd2-4b19-9b6e-c799f8cc7f37",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "88a5534b-5183-49f2-8b73-3c5c31d21e60",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e4db01a3-3621-4cea-be36-9d4d30cce8f3",
"db_currency_id": "42ccc89f-584e-4984-ab84-d786b4b91120",
"db_language_id": "77660625-563a-4078-8ca0-0c0138f9d97e",
"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-01-12T08:25:05.9486957+00:00"
},
"modified_dateutc": "2026-01-12T08:25:05.9486957+00:00"
},
"date_in_production_since": "2026-01-12T08:25:05.9486957+00:00",
"date_out_of_production_since": "2026-01-12T08:25:05.9486957+00:00",
"date_end_support": "2026-01-12T08:25:05.9486957+00:00",
"sales_organization_id": "c9984550-459d-4e56-85d5-e82d7d8425c3",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "88a5534b-5183-49f2-8b73-3c5c31d21e60",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e4db01a3-3621-4cea-be36-9d4d30cce8f3",
"db_currency_id": "42ccc89f-584e-4984-ab84-d786b4b91120",
"db_language_id": "77660625-563a-4078-8ca0-0c0138f9d97e",
"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-01-12T08:25:05.9486957+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-01-12T08:25:05.9486957+00:00"
},
"project_status_id": "a92a619a-af47-40ee-bbc2-0754ebf4c1c2",
"project_status_code": "sample string 10",
"project_status": {
"id": "cebb1ce9-0be1-4c93-ba38-ce39d553a4c9",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "722b3582-c189-4989-b6e8-f8f51a1ad036",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "88a5534b-5183-49f2-8b73-3c5c31d21e60",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e4db01a3-3621-4cea-be36-9d4d30cce8f3",
"db_currency_id": "42ccc89f-584e-4984-ab84-d786b4b91120",
"db_language_id": "77660625-563a-4078-8ca0-0c0138f9d97e",
"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-01-12T08:25:05.9486957+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-12T08:25:05.9486957+00:00"
},
"company_id": "df0965da-bfa0-437a-be2c-b4fe5e7231f7",
"company_code": "sample string 12",
"db_address_id": "5afefc69-4b1d-461d-a1e0-f524adb66d45",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "c815f978-42b1-4343-a550-16d9514f1c17",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "310ba949-e020-499a-802b-1636d38ccef0",
"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-01-12T08:25:05.9486957+00:00",
"date_create": "2026-01-12T08:25:05.9486957+00:00",
"date_update": "2026-01-12T08:25:05.9486957+00:00",
"updated_by_user_id": "c3e326a2-e1ab-4933-a89d-24b030e7b825",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-12T08:25:05.9486957+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-01-12T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-12T08:25:05.9486957+00:00",
"date_last_job": "2026-01-12T08:25:05.9486957+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-12T08:25:05.9486957+00:00",
"modified_dateutc": "2026-01-12T08:25:05.9486957+00:00",
"is_mobile_installation": true
},
"job_type_id": "ada67bb6-87ad-4093-954f-3df265537427",
"job_type_code": "sample string 7",
"job_type": {
"id": "f3a75569-ff6a-48eb-b732-a0f9af69e5f4",
"name": "sample string 2",
"sales_organization_id": "91c172d3-849c-4337-9931-c00189269dad",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-12T08:25:05.9486957+00:00",
"code": "sample string 7"
},
"job_priority_id": "c0a7812a-aa00-4e7a-9428-0290333c7f23",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "e0086b81-425b-4682-843d-2796052acd98",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "8a98596e-ed72-4136-8d3c-41a9251f601d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "88a5534b-5183-49f2-8b73-3c5c31d21e60",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e4db01a3-3621-4cea-be36-9d4d30cce8f3",
"db_currency_id": "42ccc89f-584e-4984-ab84-d786b4b91120",
"db_language_id": "77660625-563a-4078-8ca0-0c0138f9d97e",
"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-01-12T08:25:05.9486957+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-12T08:25:05.9486957+00:00"
},
"job_status_id": "6d720c4f-7a9f-4749-afdb-75ad1e3fb3c5",
"job_status_code": "sample string 11",
"db_address_id": "4501eefb-394c-490d-8303-ffdc302145ff",
"contact_id": "b55bcfc7-5b3c-41f4-b42e-c3c99c97d34d",
"requested_by_company_id": "023bc735-76fc-4644-ba3c-112494ac7952",
"requested_by_contact_id": "1f215fc2-3eca-4cb0-930b-c0569e0ab8e4",
"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-01-12T08:25:05.9486957+00:00",
"due_date": "2026-01-12T08:25:05.9486957+00:00",
"date_create": "2026-01-12T08:25:05.9486957+00:00",
"date_update": "2026-01-12T08:25:05.9486957+00:00",
"date_closed": "2026-01-12T08:25:05.9486957+00:00",
"suggested_user_id": "92254ff2-9579-4bf0-a36d-eb41ae44cca3",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "a18b6e2d-bc0f-4ba1-b747-4f323242bb89",
"db_language_id": "f73505e4-b72e-4725-a31b-f7c75f64b45d",
"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-01-12T08:25:05.9486957+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "3ed04e07-7bd9-4ad4-9d65-d4cae9f7f616",
"sales_organization": {
"id": "88a5534b-5183-49f2-8b73-3c5c31d21e60",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e4db01a3-3621-4cea-be36-9d4d30cce8f3",
"db_currency_id": "42ccc89f-584e-4984-ab84-d786b4b91120",
"db_language_id": "77660625-563a-4078-8ca0-0c0138f9d97e",
"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-01-12T08:25:05.9486957+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "0df65438-bd51-4d2b-8b62-9ece6ac0a818",
"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": "3f154629-737c-434e-bc8f-9ffdb9ce3df9",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-12T08:25:05.9486957+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "4f331b1d-8bd5-4d12-a7f3-f02901e7dcb0"
},
"suggested_date_start": "2026-01-12T08:25:05.9486957+00:00",
"skill_id": "ec725063-b097-4a57-bd97-dd6899010aff",
"skill_code": "sample string 32",
"skill": {
"id": "e992e980-aa8b-4641-ac02-08e3b442d641",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "373cb843-949b-4eab-bb62-d48b2f82b79f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "88a5534b-5183-49f2-8b73-3c5c31d21e60",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e4db01a3-3621-4cea-be36-9d4d30cce8f3",
"db_currency_id": "42ccc89f-584e-4984-ab84-d786b4b91120",
"db_language_id": "77660625-563a-4078-8ca0-0c0138f9d97e",
"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-01-12T08:25:05.9486957+00:00"
},
"modified_dateutc": "2026-01-12T08:25:05.9486957+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "d17002e2-ad96-4ee3-834c-85c0d353b7a9",
"date_reported_by_company": "2026-01-12T08:25:05.9643212+00:00",
"id2": 36,
"company_id": "d2adae5a-dc7a-4ad6-bf9b-69e707db9817",
"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": "dfe7abf0-fc25-4372-b24a-d220bc450d11",
"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-01-12T08:25:05.9643212+00:00"
},
"work_instruction_details_id": "c6a0174e-8e1b-4a51-ae50-2772de36aea3",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "31cc3495-6684-46b7-ad68-6ab295e5fba5",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "1c921d12-a81a-4aa5-be66-b3e95171a24f",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-12T08:25:05.9643212+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": "0a3477a9-805b-45b9-9515-33b1f749ba46",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-12T08:25:05.9643212+00:00"
}