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: 50 |
| 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: 50 |
| 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": "4a65cb66-e8e2-4f16-9fb5-3cbfdd14c303",
"jobs_id": "e1888666-c050-415d-9bb6-78628ed17d8d",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "fbc41e6e-928d-4e8f-9802-086f913fb0c8",
"_parent_id": "b7f69318-2c77-4c4e-8ca9-a766e8a34775",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "fb92bb52-583a-4943-89ac-961ba46efa51",
"project_reference_back_office": "sample string 5",
"project": {
"id": "80455a63-b80a-4565-914f-f40dbcc0778b",
"_parent_id": "c248a5bc-df5e-4b35-8376-e745a397c181",
"root_parent_id": "60b4082e-c345-465e-a22c-cc087ff0c02f",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "fbd2efa1-2dfa-432f-8f50-af7f5889a870",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "d88f76db-4a55-4d85-92a2-1430f2d3a94b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c5abf7c0-5b08-4104-a76d-cd3f0aee5dba",
"_parent_code": "sample string 6",
"sales_organization_id": "e0ecdb5f-ce9a-42ef-bfe8-cf162609b7ff",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "fd21974d-c9e9-4b9b-b3e0-47043c7cf3c7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ad04bf1-b6dd-4823-8575-9c66ffcb6426",
"db_currency_id": "2093ea48-4457-4896-8c15-0910b611e3b8",
"db_language_id": "e24dd687-ff9e-4289-8c74-14402828083b",
"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": "2022-08-17T03:31:45.1413074+02:00"
},
"modified_dateutc": "2022-08-17T03:31:45.1413074+02:00"
},
"equipment_model_id": "64abed78-a9b3-4331-9458-a6f3061b08de",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "9225e03f-1357-4a10-a8b6-0bc651aba7ad",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "71e997d8-95a1-4eb0-b5f3-0f2810244487",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "b8e1b008-fd7f-4624-a57d-b0cc34a9aa2e",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "5df73714-0928-4011-897d-e3e702ee2fc9",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "fd21974d-c9e9-4b9b-b3e0-47043c7cf3c7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ad04bf1-b6dd-4823-8575-9c66ffcb6426",
"db_currency_id": "2093ea48-4457-4896-8c15-0910b611e3b8",
"db_language_id": "e24dd687-ff9e-4289-8c74-14402828083b",
"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": "2022-08-17T03:31:45.1413074+02:00"
},
"modified_dateutc": "2022-08-17T03:31:45.1413074+02:00"
},
"equipment_family_id": "d68d8e21-fb17-494b-8a71-1c69a71bde2f",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "d88f76db-4a55-4d85-92a2-1430f2d3a94b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c5abf7c0-5b08-4104-a76d-cd3f0aee5dba",
"_parent_code": "sample string 6",
"sales_organization_id": "e0ecdb5f-ce9a-42ef-bfe8-cf162609b7ff",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "fd21974d-c9e9-4b9b-b3e0-47043c7cf3c7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ad04bf1-b6dd-4823-8575-9c66ffcb6426",
"db_currency_id": "2093ea48-4457-4896-8c15-0910b611e3b8",
"db_language_id": "e24dd687-ff9e-4289-8c74-14402828083b",
"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": "2022-08-17T03:31:45.1413074+02:00"
},
"modified_dateutc": "2022-08-17T03:31:45.1413074+02:00"
},
"date_in_production_since": "2022-08-17T03:31:45.1413074+02:00",
"date_out_of_production_since": "2022-08-17T03:31:45.1413074+02:00",
"date_end_support": "2022-08-17T03:31:45.1413074+02:00",
"sales_organization_id": "6096c5cb-9c3c-42a2-b8c4-7350e3318fe8",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "fd21974d-c9e9-4b9b-b3e0-47043c7cf3c7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ad04bf1-b6dd-4823-8575-9c66ffcb6426",
"db_currency_id": "2093ea48-4457-4896-8c15-0910b611e3b8",
"db_language_id": "e24dd687-ff9e-4289-8c74-14402828083b",
"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": "2022-08-17T03:31:45.1413074+02: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": "2022-08-17T03:31:45.1413074+02:00"
},
"project_status_id": "2a7b7bfe-8b67-4a39-8fef-e033dcf57d8e",
"project_status_code": "sample string 10",
"project_status": {
"id": "b3e9a26f-a08e-4e2c-aa1d-f130d6923a51",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "11d3400b-6f77-448a-b3ba-aaa8f7559686",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fd21974d-c9e9-4b9b-b3e0-47043c7cf3c7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ad04bf1-b6dd-4823-8575-9c66ffcb6426",
"db_currency_id": "2093ea48-4457-4896-8c15-0910b611e3b8",
"db_language_id": "e24dd687-ff9e-4289-8c74-14402828083b",
"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": "2022-08-17T03:31:45.1413074+02:00"
},
"code": "sample string 7",
"modified_dateutc": "2022-08-17T03:31:45.1413074+02:00"
},
"company_id": "c96ffb9d-1684-4d5a-948d-3b16ba3fd3df",
"company_code": "sample string 12",
"db_address_id": "11d87231-4b48-4db8-8a1c-e1fe43955a3b",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "8d1a9632-d750-446e-b637-67942492c230",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "d087143c-c9e8-4705-bb98-17387a47899a",
"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": "2022-08-17T03:31:45.1413074+02:00",
"date_create": "2022-08-17T03:31:45.1413074+02:00",
"date_update": "2022-08-17T03:31:45.1413074+02:00",
"updated_by_user_id": "2b04a03a-609e-4ca4-bb6e-89000de67666",
"customer_reference": "sample string 28",
"warranty_date_until": "2022-08-17T03:31:45.1413074+02: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": "2022-08-17T00:00:00+02:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2022-08-17T03:31:45.1413074+02:00",
"date_last_job": "2022-08-17T03:31:45.1413074+02:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2022-08-17T03:31:45.1413074+02:00",
"modified_dateutc": "2022-08-17T03:31:45.1413074+02:00",
"is_mobile_installation": true
},
"job_type_id": "a248e405-363a-4823-8f45-bedbfd1b4a04",
"job_type_code": "sample string 7",
"job_type": {
"id": "bfbb346b-3ab2-4011-82db-e716fc712f10",
"name": "sample string 2",
"sales_organization_id": "879e2554-55f1-4096-b056-409508910fc1",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2022-08-17T03:31:45.1413074+02:00",
"code": "sample string 7"
},
"job_priority_id": "4212fcf2-2c51-44ef-ae71-1325884cc12a",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "26571a58-7e53-4e43-a74e-cd1b0f67533f",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "c15b97b4-de97-48b4-9037-645fff28373a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fd21974d-c9e9-4b9b-b3e0-47043c7cf3c7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ad04bf1-b6dd-4823-8575-9c66ffcb6426",
"db_currency_id": "2093ea48-4457-4896-8c15-0910b611e3b8",
"db_language_id": "e24dd687-ff9e-4289-8c74-14402828083b",
"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": "2022-08-17T03:31:45.1413074+02:00"
},
"code": "sample string 7",
"modified_dateutc": "2022-08-17T03:31:45.1413074+02:00"
},
"job_status_id": "db22d4c4-592a-4990-a751-bf07063df99b",
"job_status_code": "sample string 11",
"db_address_id": "89c2098e-3c02-4c77-8f92-2a0efaa41cb0",
"contact_id": "425d50c4-9d96-4f18-b61f-9b919e2d725c",
"requested_by_company_id": "bd65b09b-69a6-444f-bda4-14cdf8dcf0ff",
"requested_by_contact_id": "ad91c6ca-7f48-4f67-922e-5d57aaedf76e",
"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": "2022-08-17T03:31:45.1413074+02:00",
"due_date": "2022-08-17T03:31:45.1413074+02:00",
"date_create": "2022-08-17T03:31:45.1413074+02:00",
"date_update": "2022-08-17T03:31:45.1413074+02:00",
"date_closed": "2022-08-17T03:31:45.1413074+02:00",
"suggested_user_id": "bb2dba02-85f7-43e9-9d2e-eaa8bb56aaee",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "67ca646b-9cc5-461b-b942-95acd7070838",
"db_language_id": "966d4378-b6bf-4bb8-b8c4-9b42cd31bd5f",
"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": "2022-08-17T03:31:45.1413074+02:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "c0ec2e0e-497a-4698-bc1a-60655276bc6d",
"sales_organization": {
"id": "fd21974d-c9e9-4b9b-b3e0-47043c7cf3c7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ad04bf1-b6dd-4823-8575-9c66ffcb6426",
"db_currency_id": "2093ea48-4457-4896-8c15-0910b611e3b8",
"db_language_id": "e24dd687-ff9e-4289-8c74-14402828083b",
"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": "2022-08-17T03:31:45.1413074+02:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "18fe0392-fd81-4ecb-9bea-639242470d7c",
"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": "7e240644-3fd2-49fa-81bb-69f490da6c31",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2022-08-17T03:31:45.1413074+02:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "7c2780a3-f4ee-4411-b504-81be37b0c0e5"
},
"suggested_date_start": "2022-08-17T03:31:45.1413074+02:00",
"skill_id": "3331d562-55b6-4ed4-b355-82676f14d867",
"skill_code": "sample string 32",
"skill": {
"id": "713f1601-2469-4cd6-97a7-ddcbfbe14d40",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "24f4f3c8-37de-4938-b9cf-d72d15b4000f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fd21974d-c9e9-4b9b-b3e0-47043c7cf3c7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ad04bf1-b6dd-4823-8575-9c66ffcb6426",
"db_currency_id": "2093ea48-4457-4896-8c15-0910b611e3b8",
"db_language_id": "e24dd687-ff9e-4289-8c74-14402828083b",
"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": "2022-08-17T03:31:45.1413074+02:00"
},
"modified_dateutc": "2022-08-17T03:31:45.1413074+02:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "db0181bd-8e96-4a85-8fbb-8288ac3cef71",
"date_reported_by_company": "2022-08-17T03:31:45.1413074+02:00",
"id2": 36,
"company_id": "1a104d41-3bb1-48ea-b9ec-432328593b93",
"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": "b2775ca0-592d-4fed-b078-d12f6860a7c8",
"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": "2022-08-17T03:31:45.1413074+02:00"
},
"work_instruction_details_id": "3084d6d8-2155-4808-9c88-66f8e3ec3d1a",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "ad895d4d-ae3f-4189-977e-7ab97966ff90",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "acebb92b-9d06-4ba2-81e6-fa7e8d6ea2c0",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2022-08-17T03:31:45.1413074+02: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": "c549c609-fe5e-464b-a699-39ccf065ceb1",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2022-08-17T03:31:45.1413074+02:00"
}