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": "72c935a2-8964-407e-961c-984ad54bc230",
"jobs_id": "cc3f5d70-f790-4850-8900-bf233032a448",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "7182b8c3-5beb-4309-bdca-fb95220446de",
"_parent_id": "40787cc4-7abd-4037-ba51-345bb22cfe6f",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "a4f182d4-3d3f-4d5e-a699-8000177c9220",
"project_reference_back_office": "sample string 5",
"project": {
"id": "3703c058-2e80-4f7b-9bb8-ee865c74252c",
"_parent_id": "83a59cc1-e4ce-4ac7-b322-0ac87be5705a",
"root_parent_id": "27b85547-2a6a-4e97-a811-44b6a3d65d94",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "8b63e681-bcae-43a5-9fc4-4aebd8947b91",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "aea80aa2-61eb-431c-81b8-9101871cc920",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "afd6750e-2033-4423-9f6e-ae61f63976f7",
"_parent_code": "sample string 6",
"sales_organization_id": "35c36c71-f1dc-4c40-bdd6-6ca8a36dfe2b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "9e6a0d08-7083-40e6-8219-dc9e488382c0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "89513848-45b5-4ac6-8ff1-668ad96be809",
"db_currency_id": "8db86be8-28d6-4b1d-ba6b-60f5d3917d03",
"db_language_id": "b906d0a8-18f1-46b5-a805-a8faa51a3e90",
"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": "2024-04-24T03:18:46.1211452+00:00"
},
"modified_dateutc": "2024-04-24T03:18:46.1211452+00:00"
},
"equipment_model_id": "d6b62d9c-7b07-4caf-a030-b0b2a11dc200",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "3604ee43-7115-4530-adf1-4b283fbba207",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "44fc1ca9-094a-472a-ad76-6f52cfadf45c",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "d71449f3-e5cc-43a2-830b-fe03de853063",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "74a1d362-d154-4c36-9848-ba7ef22835a3",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9e6a0d08-7083-40e6-8219-dc9e488382c0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "89513848-45b5-4ac6-8ff1-668ad96be809",
"db_currency_id": "8db86be8-28d6-4b1d-ba6b-60f5d3917d03",
"db_language_id": "b906d0a8-18f1-46b5-a805-a8faa51a3e90",
"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": "2024-04-24T03:18:46.1211452+00:00"
},
"modified_dateutc": "2024-04-24T03:18:46.1367674+00:00"
},
"equipment_family_id": "75d8a576-fde0-4e14-9da9-da21ac2a159b",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "aea80aa2-61eb-431c-81b8-9101871cc920",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "afd6750e-2033-4423-9f6e-ae61f63976f7",
"_parent_code": "sample string 6",
"sales_organization_id": "35c36c71-f1dc-4c40-bdd6-6ca8a36dfe2b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "9e6a0d08-7083-40e6-8219-dc9e488382c0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "89513848-45b5-4ac6-8ff1-668ad96be809",
"db_currency_id": "8db86be8-28d6-4b1d-ba6b-60f5d3917d03",
"db_language_id": "b906d0a8-18f1-46b5-a805-a8faa51a3e90",
"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": "2024-04-24T03:18:46.1211452+00:00"
},
"modified_dateutc": "2024-04-24T03:18:46.1211452+00:00"
},
"date_in_production_since": "2024-04-24T03:18:46.1367674+00:00",
"date_out_of_production_since": "2024-04-24T03:18:46.1367674+00:00",
"date_end_support": "2024-04-24T03:18:46.1367674+00:00",
"sales_organization_id": "2ef6ace5-30ff-4a2e-9f38-b6586807ff39",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "9e6a0d08-7083-40e6-8219-dc9e488382c0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "89513848-45b5-4ac6-8ff1-668ad96be809",
"db_currency_id": "8db86be8-28d6-4b1d-ba6b-60f5d3917d03",
"db_language_id": "b906d0a8-18f1-46b5-a805-a8faa51a3e90",
"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": "2024-04-24T03:18:46.1211452+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": "2024-04-24T03:18:46.1367674+00:00"
},
"project_status_id": "e682e8c9-7ccb-4aa2-823f-2d06331f278e",
"project_status_code": "sample string 10",
"project_status": {
"id": "790e3d51-4454-4b82-a72d-447ebca9ffdf",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "9d9e84f5-692a-4e9d-8fd5-01c775df17dd",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9e6a0d08-7083-40e6-8219-dc9e488382c0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "89513848-45b5-4ac6-8ff1-668ad96be809",
"db_currency_id": "8db86be8-28d6-4b1d-ba6b-60f5d3917d03",
"db_language_id": "b906d0a8-18f1-46b5-a805-a8faa51a3e90",
"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": "2024-04-24T03:18:46.1211452+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2024-04-24T03:18:46.1367674+00:00"
},
"company_id": "69ad7ed1-ab58-4e10-b118-168b62964c41",
"company_code": "sample string 12",
"db_address_id": "a696301f-7ecb-4242-b383-387823092e6a",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "835408e8-1e79-4f70-bcf7-c96a21b606ad",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "fbba0c72-a645-4c7c-9dba-89fe1aea7267",
"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": "2024-04-24T03:18:46.1367674+00:00",
"date_create": "2024-04-24T03:18:46.1367674+00:00",
"date_update": "2024-04-24T03:18:46.1367674+00:00",
"updated_by_user_id": "1e2c02d4-3603-4921-a574-78ce1e3983e7",
"customer_reference": "sample string 28",
"warranty_date_until": "2024-04-24T03:18:46.1367674+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": "2024-04-24T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2024-04-24T03:18:46.1367674+00:00",
"date_last_job": "2024-04-24T03:18:46.1367674+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2024-04-24T03:18:46.1367674+00:00",
"modified_dateutc": "2024-04-24T03:18:46.1367674+00:00",
"is_mobile_installation": true
},
"job_type_id": "51f1f167-37ac-4c5b-9366-55a915155426",
"job_type_code": "sample string 7",
"job_type": {
"id": "5e42a979-1f0a-4a34-98c2-233eb9a8f5a1",
"name": "sample string 2",
"sales_organization_id": "fb5421bb-f591-4f4b-967a-96fe79d3c2c6",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2024-04-24T03:18:46.1367674+00:00",
"code": "sample string 7"
},
"job_priority_id": "f8ef6194-18bd-432c-968e-14ca0716d4b2",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "d0d243c9-fed8-48fe-b387-10bda648ac8c",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "675c82ba-f05e-4f3e-9dfc-cff1873cef37",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9e6a0d08-7083-40e6-8219-dc9e488382c0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "89513848-45b5-4ac6-8ff1-668ad96be809",
"db_currency_id": "8db86be8-28d6-4b1d-ba6b-60f5d3917d03",
"db_language_id": "b906d0a8-18f1-46b5-a805-a8faa51a3e90",
"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": "2024-04-24T03:18:46.1211452+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2024-04-24T03:18:46.1367674+00:00"
},
"job_status_id": "0cbc60fb-0cc6-46e3-a7cf-62b67b02a4ae",
"job_status_code": "sample string 11",
"db_address_id": "57f462e4-32ad-4961-88fe-46ff13173c5a",
"contact_id": "489f7647-3c56-481e-b47d-e7690b2a5e34",
"requested_by_company_id": "6ffd8b2c-c50e-4878-a65c-b3eac55d1796",
"requested_by_contact_id": "acca0593-4a6c-41e1-8ac8-439c0e703153",
"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": "2024-04-24T03:18:46.1367674+00:00",
"due_date": "2024-04-24T03:18:46.1367674+00:00",
"date_create": "2024-04-24T03:18:46.1367674+00:00",
"date_update": "2024-04-24T03:18:46.1367674+00:00",
"date_closed": "2024-04-24T03:18:46.1367674+00:00",
"suggested_user_id": "4724b56f-8a1a-4846-a597-8ddc3bc76de6",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "43d85b61-66c1-4ad2-a554-eee7d5efd712",
"db_language_id": "2d126ca1-05d0-4727-9472-2e23fb9353a0",
"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": "2024-04-24T03:18:46.1367674+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "920cf3dd-5865-4ae6-ba6b-dc91940bb14e",
"sales_organization": {
"id": "9e6a0d08-7083-40e6-8219-dc9e488382c0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "89513848-45b5-4ac6-8ff1-668ad96be809",
"db_currency_id": "8db86be8-28d6-4b1d-ba6b-60f5d3917d03",
"db_language_id": "b906d0a8-18f1-46b5-a805-a8faa51a3e90",
"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": "2024-04-24T03:18:46.1211452+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "58671bde-84cd-430d-b06c-137921de5b49",
"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": "0869fbb3-d0b6-4ee0-943c-e84f45da23b7",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2024-04-24T03:18:46.1367674+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "ff5a125b-f60e-4eb7-8bb8-601fa87c2187"
},
"suggested_date_start": "2024-04-24T03:18:46.1367674+00:00",
"skill_id": "069ad709-cd66-45e2-b97c-61ebdc8d15eb",
"skill_code": "sample string 32",
"skill": {
"id": "6d3814e6-356d-4a7b-943e-2fba569ea3d2",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "3bec5f0d-e40f-4a41-96e7-7804dd4b27d4",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9e6a0d08-7083-40e6-8219-dc9e488382c0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "89513848-45b5-4ac6-8ff1-668ad96be809",
"db_currency_id": "8db86be8-28d6-4b1d-ba6b-60f5d3917d03",
"db_language_id": "b906d0a8-18f1-46b5-a805-a8faa51a3e90",
"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": "2024-04-24T03:18:46.1211452+00:00"
},
"modified_dateutc": "2024-04-24T03:18:46.1367674+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "6bf0a50e-5e44-4cd1-a918-a01b2f81c769",
"date_reported_by_company": "2024-04-24T03:18:46.1367674+00:00",
"id2": 36,
"company_id": "75e5a58c-276c-4a35-9918-d25a4e328780",
"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": "d995d1f3-b9a9-4fb3-9a45-bea3f27b2507",
"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": "2024-04-24T03:18:46.1367674+00:00"
},
"work_instruction_details_id": "f1291a9d-a90a-4f12-8010-7946751735bf",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "8bfc1123-30d8-4daf-abf3-12d4aaccf6d9",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "cfa33118-208c-4153-8183-6996873c4d9b",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2024-04-24T03:18:46.1367674+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": "2ad83df3-d9e1-4c96-a947-7a055d33a1d3",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2024-04-24T03:18:46.1367674+00:00"
}