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": "218d6957-791f-4186-bdc7-cf7274e12668",
"jobs_id": "186cd5cf-1107-4de5-88af-3085b88f1632",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "e9d3fe0a-a222-4ea0-a8f9-ddd3b6aa662b",
"_parent_id": "ca7bc1b7-703d-4c01-b28f-e6ed9165255a",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "e914b05c-b2a0-4937-8c57-6a7b749abc69",
"project_reference_back_office": "sample string 5",
"project": {
"id": "3cf45685-9a01-4086-a107-86c302ca4588",
"_parent_id": "5338c34d-468c-4b97-b547-9d46911bcbff",
"root_parent_id": "f056f0f0-832e-4ab0-8fcc-48177c7c37bc",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "9d2df10e-cc5e-43ec-a35d-88a39d38d2b4",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "2552ecdd-920a-4616-835b-f5a285011e64",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9ef46f14-81fe-4b78-93b0-6d4d61947076",
"_parent_code": "sample string 6",
"sales_organization_id": "d4fb41db-c225-425d-8462-c7d64206085f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "90d24209-5d53-44b1-b939-2812462b8453",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7c3b843a-5490-474c-b103-0104c1d17a5d",
"db_currency_id": "2a82c05e-fceb-401d-ad5c-1e2d62c7c84b",
"db_language_id": "5accf165-26d8-489c-b1c0-5eea3d22be3e",
"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-06-21T11:07:56.9699204+00:00"
},
"modified_dateutc": "2025-06-21T11:07:56.9699204+00:00"
},
"equipment_model_id": "6eeacf84-9b12-47af-a0ce-eef3ad09f026",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "25d363d1-0232-4540-ba5b-ef426f6f5f04",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "a6b254a7-a6ae-49fd-8a04-bc026857f8db",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "79060c83-0d49-4cc9-bbcc-e2c0b4a738cb",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "12debaea-e850-48b8-80f8-8d6b2b7f2aa4",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "90d24209-5d53-44b1-b939-2812462b8453",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7c3b843a-5490-474c-b103-0104c1d17a5d",
"db_currency_id": "2a82c05e-fceb-401d-ad5c-1e2d62c7c84b",
"db_language_id": "5accf165-26d8-489c-b1c0-5eea3d22be3e",
"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-06-21T11:07:56.9699204+00:00"
},
"modified_dateutc": "2025-06-21T11:07:56.9699204+00:00"
},
"equipment_family_id": "5a8c2b70-ae31-4d0e-9ea4-91c9b208c783",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "2552ecdd-920a-4616-835b-f5a285011e64",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9ef46f14-81fe-4b78-93b0-6d4d61947076",
"_parent_code": "sample string 6",
"sales_organization_id": "d4fb41db-c225-425d-8462-c7d64206085f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "90d24209-5d53-44b1-b939-2812462b8453",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7c3b843a-5490-474c-b103-0104c1d17a5d",
"db_currency_id": "2a82c05e-fceb-401d-ad5c-1e2d62c7c84b",
"db_language_id": "5accf165-26d8-489c-b1c0-5eea3d22be3e",
"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-06-21T11:07:56.9699204+00:00"
},
"modified_dateutc": "2025-06-21T11:07:56.9699204+00:00"
},
"date_in_production_since": "2025-06-21T11:07:56.9699204+00:00",
"date_out_of_production_since": "2025-06-21T11:07:56.9699204+00:00",
"date_end_support": "2025-06-21T11:07:56.9699204+00:00",
"sales_organization_id": "f04c548a-b16e-4b8e-9024-77de804ac101",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "90d24209-5d53-44b1-b939-2812462b8453",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7c3b843a-5490-474c-b103-0104c1d17a5d",
"db_currency_id": "2a82c05e-fceb-401d-ad5c-1e2d62c7c84b",
"db_language_id": "5accf165-26d8-489c-b1c0-5eea3d22be3e",
"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-06-21T11:07:56.9699204+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-06-21T11:07:56.9699204+00:00"
},
"project_status_id": "01af28fa-781b-4246-9aed-bb82884883a9",
"project_status_code": "sample string 10",
"project_status": {
"id": "41961a91-9087-4a18-a440-36f8bdd767e3",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "22aac05b-2f91-465e-b8ce-4a04edd39976",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "90d24209-5d53-44b1-b939-2812462b8453",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7c3b843a-5490-474c-b103-0104c1d17a5d",
"db_currency_id": "2a82c05e-fceb-401d-ad5c-1e2d62c7c84b",
"db_language_id": "5accf165-26d8-489c-b1c0-5eea3d22be3e",
"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-06-21T11:07:56.9699204+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-06-21T11:07:56.9699204+00:00"
},
"company_id": "631e2279-2bab-4cb9-95bf-bad9fc48be4a",
"company_code": "sample string 12",
"db_address_id": "7a66e13d-1b6c-43c5-a4e4-ada5a7665727",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "02a7e889-ff32-4f81-a315-d9770d4686e9",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "68563cbd-c8ed-4964-8926-c796127e978f",
"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-06-21T11:07:56.9699204+00:00",
"date_create": "2025-06-21T11:07:56.9699204+00:00",
"date_update": "2025-06-21T11:07:56.9699204+00:00",
"updated_by_user_id": "8f37dea7-0269-4879-bffb-c548e58cdf2f",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-06-21T11:07:56.9699204+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-06-21T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-06-21T11:07:56.9699204+00:00",
"date_last_job": "2025-06-21T11:07:56.9699204+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-06-21T11:07:56.9699204+00:00",
"modified_dateutc": "2025-06-21T11:07:56.9699204+00:00",
"is_mobile_installation": true
},
"job_type_id": "2dbcb5b7-01fb-4ff6-941c-343499522a3b",
"job_type_code": "sample string 7",
"job_type": {
"id": "e5f2c1cc-f188-40ec-be6c-677ae90b463f",
"name": "sample string 2",
"sales_organization_id": "3c92154d-7f7d-4879-93ea-cf2e8b40f93b",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-06-21T11:07:56.9699204+00:00",
"code": "sample string 7"
},
"job_priority_id": "00e2819c-a2c0-478b-a304-61fafdb08ccd",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "9c87a6fc-baf0-486f-abc9-b00b650c485e",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "73eef348-531b-4d5f-927e-1820aab7e833",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "90d24209-5d53-44b1-b939-2812462b8453",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7c3b843a-5490-474c-b103-0104c1d17a5d",
"db_currency_id": "2a82c05e-fceb-401d-ad5c-1e2d62c7c84b",
"db_language_id": "5accf165-26d8-489c-b1c0-5eea3d22be3e",
"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-06-21T11:07:56.9699204+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-06-21T11:07:56.9699204+00:00"
},
"job_status_id": "8b1c7442-bb33-4d15-8c01-91d468f5e51c",
"job_status_code": "sample string 11",
"db_address_id": "7e3bdb6d-d007-4d59-bd48-4075ec69aa49",
"contact_id": "4fcc09e8-1552-4f05-b113-163ce5a1a15a",
"requested_by_company_id": "de1b3d26-1162-4f0a-9ba4-60b9bde89012",
"requested_by_contact_id": "69a6a8c2-4668-4681-8a55-04a130a09fb9",
"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-06-21T11:07:56.9699204+00:00",
"due_date": "2025-06-21T11:07:56.9699204+00:00",
"date_create": "2025-06-21T11:07:56.9699204+00:00",
"date_update": "2025-06-21T11:07:56.9699204+00:00",
"date_closed": "2025-06-21T11:07:56.9699204+00:00",
"suggested_user_id": "aa3451b4-5ce5-4cd4-8a4b-6c84b1f8be27",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "a06ed475-36e3-43a9-bcc1-160d719e77f9",
"db_language_id": "d3a1807b-37d1-43f0-bd6b-6ee7aa9eca85",
"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-06-21T11:07:56.9699204+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "0c69f252-0109-4f52-bf2c-184cb500597f",
"sales_organization": {
"id": "90d24209-5d53-44b1-b939-2812462b8453",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7c3b843a-5490-474c-b103-0104c1d17a5d",
"db_currency_id": "2a82c05e-fceb-401d-ad5c-1e2d62c7c84b",
"db_language_id": "5accf165-26d8-489c-b1c0-5eea3d22be3e",
"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-06-21T11:07:56.9699204+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "68bf8fdd-6a6a-4df1-9645-eccba191635d",
"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": "0fa51293-a1ef-40a3-a8d4-50770fffef70",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-06-21T11:07:56.9699204+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "5cb2eeef-c666-41a8-9657-807d4c9a7054"
},
"suggested_date_start": "2025-06-21T11:07:56.9699204+00:00",
"skill_id": "1e876f8f-d7ee-48ba-8240-454c23180c3d",
"skill_code": "sample string 32",
"skill": {
"id": "3ebea0fa-bbbe-4b7c-a760-2231e2d91268",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "14520abd-2ede-47b9-9d7f-f9816ddf39cf",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "90d24209-5d53-44b1-b939-2812462b8453",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7c3b843a-5490-474c-b103-0104c1d17a5d",
"db_currency_id": "2a82c05e-fceb-401d-ad5c-1e2d62c7c84b",
"db_language_id": "5accf165-26d8-489c-b1c0-5eea3d22be3e",
"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-06-21T11:07:56.9699204+00:00"
},
"modified_dateutc": "2025-06-21T11:07:56.9699204+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "ad7abf3f-15a0-4614-91e3-2c99435ddd53",
"date_reported_by_company": "2025-06-21T11:07:56.9699204+00:00",
"id2": 36,
"company_id": "c6bc1fad-cb58-4326-a89b-0ff533c76786",
"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": "b977c58a-a08b-429a-92a1-b0537c9add8a",
"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-06-21T11:07:56.9699204+00:00"
},
"work_instruction_details_id": "8518588a-4c31-4b03-a5a4-882c40ff30f1",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "74890c51-b0f7-43a3-a8ca-69a386876ab5",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "aa48d57d-3791-4774-acb9-944633c92c62",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-06-21T11:07:56.9699204+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": "6126c18b-0773-48c0-8e70-2fbb9ca292e0",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-06-21T11:07:56.9699204+00:00"
}