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": "a91da90e-c0c3-49c7-a1ab-f65862fd88ac",
"jobs_id": "7a4d82f1-c314-4680-aede-668ce1bc8b19",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "980c6b2c-2892-4167-a4b1-a546879d5fd8",
"_parent_id": "05764287-603f-4d03-8bd0-f493b8015aa3",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "010eb50d-f88a-401d-90b8-a0e822ca448b",
"project_reference_back_office": "sample string 5",
"project": {
"id": "a5ce5c4f-ce29-412d-b175-84c2c97ad899",
"_parent_id": "93b791a8-3547-4535-9dc6-c543ad9b2fc6",
"root_parent_id": "349de54e-b24a-4b25-8c6a-8e6875d6f456",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "83e09064-b19e-45a4-8680-aed151f36131",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "0ec35c74-6712-4632-ab09-988addd09dbc",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "bb5c9d18-7172-43bb-b6b4-3e399881cb49",
"_parent_code": "sample string 6",
"sales_organization_id": "3594a685-fb41-4b23-9854-bcfcdbaaa439",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b9dfd9ca-b12c-4e2e-afd7-772fa524df3b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dfdc4a45-4db8-4982-a73b-452740c02024",
"db_currency_id": "b2ff28e9-6459-43ef-9a7f-1ada3d3a7e6c",
"db_language_id": "a0dac8ee-c8ab-4742-a4b7-2791bccaf77f",
"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-01T17:20:53.7287677+00:00"
},
"modified_dateutc": "2026-11-01T17:20:53.7287677+00:00"
},
"equipment_model_id": "0147a24d-9d78-4c9e-8ea2-acfae6dd8aba",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "df07b86f-27ae-445d-a8f3-bd7737bfc043",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "b4096b50-21b5-4c1f-96f1-dbda5c2a32bb",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "ebc09711-4aca-48f0-b289-86011fa4f0ce",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "c3ed9a37-efcb-4ece-a1d3-35fdccef2fcc",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b9dfd9ca-b12c-4e2e-afd7-772fa524df3b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dfdc4a45-4db8-4982-a73b-452740c02024",
"db_currency_id": "b2ff28e9-6459-43ef-9a7f-1ada3d3a7e6c",
"db_language_id": "a0dac8ee-c8ab-4742-a4b7-2791bccaf77f",
"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-01T17:20:53.7287677+00:00"
},
"modified_dateutc": "2026-11-01T17:20:53.7287677+00:00"
},
"equipment_family_id": "7689d4fc-bc71-4ac9-95e2-5de41eabc90a",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "0ec35c74-6712-4632-ab09-988addd09dbc",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "bb5c9d18-7172-43bb-b6b4-3e399881cb49",
"_parent_code": "sample string 6",
"sales_organization_id": "3594a685-fb41-4b23-9854-bcfcdbaaa439",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b9dfd9ca-b12c-4e2e-afd7-772fa524df3b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dfdc4a45-4db8-4982-a73b-452740c02024",
"db_currency_id": "b2ff28e9-6459-43ef-9a7f-1ada3d3a7e6c",
"db_language_id": "a0dac8ee-c8ab-4742-a4b7-2791bccaf77f",
"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-01T17:20:53.7287677+00:00"
},
"modified_dateutc": "2026-11-01T17:20:53.7287677+00:00"
},
"date_in_production_since": "2026-11-01T17:20:53.7287677+00:00",
"date_out_of_production_since": "2026-11-01T17:20:53.7287677+00:00",
"date_end_support": "2026-11-01T17:20:53.7287677+00:00",
"sales_organization_id": "f0fc1642-ec50-4fa0-a6c7-c70e36cae1a3",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "b9dfd9ca-b12c-4e2e-afd7-772fa524df3b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dfdc4a45-4db8-4982-a73b-452740c02024",
"db_currency_id": "b2ff28e9-6459-43ef-9a7f-1ada3d3a7e6c",
"db_language_id": "a0dac8ee-c8ab-4742-a4b7-2791bccaf77f",
"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-01T17:20:53.7287677+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-01T17:20:53.7287677+00:00"
},
"project_status_id": "dd68c8b3-ec85-4d11-866f-9633b0753448",
"project_status_code": "sample string 10",
"project_status": {
"id": "17bfb9ee-df68-4161-9772-30bbae4bddce",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "37d913db-f6db-4ab4-9797-098b18d3514f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b9dfd9ca-b12c-4e2e-afd7-772fa524df3b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dfdc4a45-4db8-4982-a73b-452740c02024",
"db_currency_id": "b2ff28e9-6459-43ef-9a7f-1ada3d3a7e6c",
"db_language_id": "a0dac8ee-c8ab-4742-a4b7-2791bccaf77f",
"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-01T17:20:53.7287677+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-01T17:20:53.7287677+00:00"
},
"company_id": "185af23a-f35c-44af-b263-d6adbdbcb4a7",
"company_code": "sample string 12",
"db_address_id": "7e5dc140-81ce-40fb-b451-e0a19e429461",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "e5b48741-0a91-403c-ab87-9513fe21ecb7",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "983b1052-7193-4581-bc74-b787b712061b",
"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-01T17:20:53.7287677+00:00",
"date_create": "2026-11-01T17:20:53.7287677+00:00",
"date_update": "2026-11-01T17:20:53.7287677+00:00",
"updated_by_user_id": "04083f17-e27c-4020-8a34-a25bc9c09d92",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-11-01T17:20:53.7287677+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-01T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-11-01T17:20:53.7287677+00:00",
"date_last_job": "2026-11-01T17:20:53.7287677+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-11-01T17:20:53.7287677+00:00",
"modified_dateutc": "2026-11-01T17:20:53.7287677+00:00",
"is_mobile_installation": true
},
"job_type_id": "bbd7d50d-0e19-4e1e-abb3-ae401788cea0",
"job_type_code": "sample string 7",
"job_type": {
"id": "27e9a63c-bc83-4062-9fc2-1754e1ef7630",
"name": "sample string 2",
"sales_organization_id": "a71333d3-6211-405e-a23f-d96dbcd91346",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-11-01T17:20:53.7397264+00:00",
"code": "sample string 7"
},
"job_priority_id": "306c82ba-a085-479d-bf61-dd896009c897",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "7acfd23a-9bed-4a3e-ba27-d8cc1cb0377b",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "0f2deb6c-8440-4e5f-b700-16da2a172a5b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b9dfd9ca-b12c-4e2e-afd7-772fa524df3b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dfdc4a45-4db8-4982-a73b-452740c02024",
"db_currency_id": "b2ff28e9-6459-43ef-9a7f-1ada3d3a7e6c",
"db_language_id": "a0dac8ee-c8ab-4742-a4b7-2791bccaf77f",
"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-01T17:20:53.7287677+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-01T17:20:53.7397264+00:00"
},
"job_status_id": "3bba978e-6539-40e6-a6df-0979b12419e7",
"job_status_code": "sample string 11",
"db_address_id": "848125aa-ba66-447f-85fc-a5405ac81c1f",
"contact_id": "3e6d75e1-bde9-483a-b374-7b0135841b9d",
"requested_by_company_id": "cb06e1f2-d309-47a7-98f6-1e1b1c0f729f",
"requested_by_contact_id": "97a8e1c7-0db4-4e29-a779-f62ecf58a6e5",
"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-01T17:20:53.7397264+00:00",
"due_date": "2026-11-01T17:20:53.7397264+00:00",
"date_create": "2026-11-01T17:20:53.7397264+00:00",
"date_update": "2026-11-01T17:20:53.7397264+00:00",
"date_closed": "2026-11-01T17:20:53.7397264+00:00",
"suggested_user_id": "c51af492-3a51-4d60-9ffb-d3ce3f60ac90",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "c9c8b9ea-ef0c-4f71-b2d9-c3cd1b5bfb3f",
"db_language_id": "4ae84afa-75ee-4f17-bb8f-c04867f1df20",
"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-01T17:20:53.7397264+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "6e4595c2-bc52-4051-acd4-b1e8f496f44b",
"sales_organization": {
"id": "b9dfd9ca-b12c-4e2e-afd7-772fa524df3b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dfdc4a45-4db8-4982-a73b-452740c02024",
"db_currency_id": "b2ff28e9-6459-43ef-9a7f-1ada3d3a7e6c",
"db_language_id": "a0dac8ee-c8ab-4742-a4b7-2791bccaf77f",
"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-01T17:20:53.7287677+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "d49ad322-1ecd-474b-9957-f8a3299f3184",
"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": "78e27559-1ad4-4036-80f9-fee39d29ed31",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-11-01T17:20:53.7397264+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "e9747cb1-ecde-4d69-ba65-c7979d3fee83"
},
"suggested_date_start": "2026-11-01T17:20:53.7397264+00:00",
"skill_id": "94027f3f-4c8f-4e64-9700-50e2b7261ebe",
"skill_code": "sample string 32",
"skill": {
"id": "b0b0ce8f-f52e-4a93-befe-3b80be68a53d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "0e9c45f6-1d29-4420-891c-bf1da20a3cd4",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b9dfd9ca-b12c-4e2e-afd7-772fa524df3b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dfdc4a45-4db8-4982-a73b-452740c02024",
"db_currency_id": "b2ff28e9-6459-43ef-9a7f-1ada3d3a7e6c",
"db_language_id": "a0dac8ee-c8ab-4742-a4b7-2791bccaf77f",
"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-01T17:20:53.7287677+00:00"
},
"modified_dateutc": "2026-11-01T17:20:53.7397264+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "1bb20830-7d2d-41cd-abf1-895af7ada10a",
"date_reported_by_company": "2026-11-01T17:20:53.7397264+00:00",
"id2": 36,
"company_id": "cf4306a8-d3ad-4f35-8a21-dcf5f6692c13",
"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": "04f8b809-3092-4c28-bfa2-d14eecb8acbb",
"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-01T17:20:53.7397264+00:00"
},
"work_instruction_details_id": "1c6cad7f-c826-45cd-8020-158c6b7b62f0",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "5f546569-87f3-4aab-a6c4-ea969b07da71",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "21c576ce-bde4-41ab-abe8-d304fcba1746",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-11-01T17:20:53.7397264+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": "43c7feb6-7951-4e19-b68d-83f04252c359",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-11-01T17:20:53.7397264+00:00"
}