Retrieves all the work orders
Request Information
URI Parameters :
None.
Body Parameters :
None.
Response Information
Resource Description :
IHttpActionResult
jobsName | Description | Type | Additional information |
---|---|---|---|
id |
Primary Key |
globally unique identifier | |
_parent_id |
Reference to a parent job (in case of Multi Job) |
globally unique identifier | |
_parent_job |
Embedded entity "job" for parent (multi job level) when adding/updating job |
jobs | |
_parent_jobs_reference_back_office |
Embedded entity "job" for parent (multi job level) using ERP PK when adding/updating job |
string | |
project_id |
Foreign key of project for this job |
globally unique identifier |
Optionally required : project_id, project_reference_back_office or project must be provided |
project_reference_back_office |
Embedded entity "project" using ERP PK when adding/updating job |
string |
Optionally required : project_id, project_reference_back_office or project must be provided |
project |
Embedded entity "project" when adding/updating job |
project |
Optionally required : project_id, project_reference_back_office or project must be provided |
job_type_id |
Foreign key of job type for this job |
globally unique identifier |
Optionally required : job_type_id, job_type_code or job_type must be provided |
job_type_code |
Embedded entity "job_type" using ERP PK when adding/updating job |
string |
Optionally required : job_type_id, job_type_code or job_type must be provided |
job_type |
Embedded entity "job_type" when adding/updating job |
job_type |
Optionally required : job_type_id, job_type_code or job_type must be provided |
job_priority_id |
Foreign key of job priority for this job |
globally unique identifier | |
job_priority_code |
Foreign key of job status for this job. If you don't know the GUID, use job_type_code |
string | |
job_priority |
Embedded entity "job_priority" when adding/updating job |
job_priority | |
job_status_id |
Foreign key of job status for this job |
globally unique identifier |
Optionally required : job_status_id or job_status_code must be provided |
job_status_code |
Foreign key of job status using code. Use "Canceled,ToBePlanned, Waiting, Pooling, Suggested, Activated or Open" If Status=Suggested AND suggested_user filled AND suggested_date_start filled THEN a job_planning will be added |
string |
Optionally required : job_status_id or job_status_code must be provided |
db_address_id |
Foreign key of db_address if job is not on a mobile equipment.Must be the address_id of the location or the equipment |
globally unique identifier | |
contact_id |
Foreign key of contact if the main contact of the job is different than the one of the project |
globally unique identifier | |
requested_by_company_id |
Foreign key of company if a specific company makes the request for this job |
globally unique identifier | |
requested_by_contact_id |
Foreign key of contact to specify why contact of the requested_company_id makes the request |
globally unique identifier | |
reference_back_office |
The Id/Ref of the back office for this job. Used by Embedded entity |
string |
Max length: 50 |
name |
Name of the Job |
string |
Required Max length: 255 |
description |
Description of the job |
string |
Max length: 4000 |
working_sequence |
In case of mutli job, they will be ordered by this sequence |
integer | |
internal_memo |
Internal field for communication between BackOffice/Planners/Technicians |
string | |
prejob_information |
Information usefull for the technician before start (Call the customer,...) |
string | |
estimated_time |
Estimation of the time needed (in minute). Will be used for planning and statistic |
integer | |
earliest_date_plannable |
Use this field if there is a minimum date for the planning (Not Before) |
date | |
due_date |
Deadline of Max date for the planning (Not After) |
date | |
date_create |
Creation date+time |
date | |
date_update |
Update date+time |
date | |
date_closed |
Date+time job goes to completed |
date | |
suggested_user_id |
Foreign key of user if there is a suggested user (used for planning) If Status=Suggested AND suggested_user filled AND suggested_date_start filled THEN a job_planning will be added |
globally unique identifier | |
suggested_user_code |
Embedded entity "suggested user" using ERP PK when adding/updating job |
string | |
suggested_user |
Embedded entity "sugessted user" when adding/updating job |
user | |
suggested_date_start |
Suggested date+time start (used for planning) If Status=Suggested AND suggested_user filled AND suggested_date_start filled THEN a job_planning will be added |
date | |
skill_id |
Foreign key of skill if the job requires a specific skill (used for planning) |
globally unique identifier | |
skill_code |
Embedded entity "skill" using ERP PK when adding/updating job |
string | |
skill |
Embedded entity "skill" when adding/updating job |
skill | |
customer_reference |
Reference of this job for the customer |
string |
Max length: 50 |
approval_responsible_user_id |
In case of multi user job, foreign key of user that is the "WO Leader" |
globally unique identifier | |
date_reported_by_company |
Date+time when company reported the problem |
date | |
id2 |
Internal ID (numeric). Will be used if reference_back_office is empty |
integer | |
company_id |
This field will be filled automatically based on the project_id |
globally unique identifier | |
company_code |
This field will be filled automatically based on the project_id |
string | |
db_address_name |
When mobile equipment, the address to use |
string |
Max length: 100 |
db_address_street |
When mobile equipment, the address to use and this field is mandatory |
string |
Max length: 50 |
db_address_street2 |
It is sub street |
string |
Max length: 50 |
db_address_street_number |
When mobile equipment, the address to use |
string |
Max length: 50 |
db_address_city |
When mobile equipment, the address to use and this field is mandatory |
string |
Max length: 50 |
db_address_zip |
When mobile equipment, the address to use and this field is mandatory |
string |
Max length: 50 |
db_address_db_country_id |
When mobile equipment, the address to use |
globally unique identifier | |
db_address_db_country_code |
When mobile equipment, the address to use |
string | |
db_address_phone |
When mobile equipment, the address to use |
string |
Max length: 50 |
db_address_email |
When mobile equipment, the address to use |
string |
Max length: 250 |
db_address_latitude_decimal |
Latitude |
decimal number | |
db_address_longitude_decimal |
Latitude |
decimal number | |
estimated_quantity_remark |
Description of the parts your technician should use or pick up |
string |
Max length: 4000 |
modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date |
Response Formats
application/json, text/json
{ "id": "d567265e-82c1-4a00-9c5b-234353ed2549", "_parent_id": "8b54a60a-9ee1-4518-b68f-b23ddc803274", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "2dee5802-993a-4ab4-bd66-c7e1651137c2", "project_reference_back_office": "sample string 5", "project": { "id": "0117d55c-4dc2-4ccb-95f4-7a87edc4a293", "_parent_id": "946198ee-6ecc-47d5-a8f1-d874e1717688", "root_parent_id": "6091f366-7b9c-4984-9d40-130733c2aedc", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "adb71766-6ffb-4268-b188-6501dbc264da", "equipment_family_code": "sample string 6", "equipment_family": { "id": "97e653b4-c864-4d3f-9fee-2e21b10fa9e6", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "65ff56ea-7dd3-4cb2-9a1e-5942aa47d395", "_parent_code": "sample string 6", "sales_organization_id": "05e2365b-8b05-490b-8e45-27517535e3c1", "sales_organization_code": "sample string 8", "sales_organization": { "id": "ca62525a-ba63-4807-bbfd-a34d3d18fede", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "c44b22a9-d3d3-4559-834a-60b950a9554b", "db_currency_id": "ab45a46d-efe8-40fe-91e2-72c56add4961", "db_language_id": "1dd3e8e8-daca-49b4-ab02-dd3fe6488a26", "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": "2023-03-30T21:13:47.0327521+00:00" }, "modified_dateutc": "2023-03-30T21:13:47.0327521+00:00" }, "equipment_model_id": "bc577f7c-87d2-4f5c-9ecc-ffca5ebe92e6", "equipment_model_code": "sample string 8", "equipment_model": { "id": "9e8e75b5-0e8b-483e-911a-26cd456e7e5f", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "51f5e1c7-5877-45a6-b0f6-3451343c161b", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "c9ab33c0-f201-43ca-be14-1a8a5cdd426a", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "d6599c42-c16f-4162-a1a8-f81a6b152a24", "sales_organization_code": "sample string 5", "sales_organization": { "id": "ca62525a-ba63-4807-bbfd-a34d3d18fede", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "c44b22a9-d3d3-4559-834a-60b950a9554b", "db_currency_id": "ab45a46d-efe8-40fe-91e2-72c56add4961", "db_language_id": "1dd3e8e8-daca-49b4-ab02-dd3fe6488a26", "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": "2023-03-30T21:13:47.0327521+00:00" }, "modified_dateutc": "2023-03-30T21:13:47.0327521+00:00" }, "equipment_family_id": "12f4544b-b621-4f2e-922a-c38a4c78059c", "equipment_family_code": "sample string 8", "equipment_family": { "id": "97e653b4-c864-4d3f-9fee-2e21b10fa9e6", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "65ff56ea-7dd3-4cb2-9a1e-5942aa47d395", "_parent_code": "sample string 6", "sales_organization_id": "05e2365b-8b05-490b-8e45-27517535e3c1", "sales_organization_code": "sample string 8", "sales_organization": { "id": "ca62525a-ba63-4807-bbfd-a34d3d18fede", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "c44b22a9-d3d3-4559-834a-60b950a9554b", "db_currency_id": "ab45a46d-efe8-40fe-91e2-72c56add4961", "db_language_id": "1dd3e8e8-daca-49b4-ab02-dd3fe6488a26", "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": "2023-03-30T21:13:47.0327521+00:00" }, "modified_dateutc": "2023-03-30T21:13:47.0327521+00:00" }, "date_in_production_since": "2023-03-30T21:13:47.0327521+00:00", "date_out_of_production_since": "2023-03-30T21:13:47.0327521+00:00", "date_end_support": "2023-03-30T21:13:47.0327521+00:00", "sales_organization_id": "b3a91188-14a5-4f84-b619-e2a0d6e8ab62", "sales_organization_code": "sample string 13", "sales_organization": { "id": "ca62525a-ba63-4807-bbfd-a34d3d18fede", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "c44b22a9-d3d3-4559-834a-60b950a9554b", "db_currency_id": "ab45a46d-efe8-40fe-91e2-72c56add4961", "db_language_id": "1dd3e8e8-daca-49b4-ab02-dd3fe6488a26", "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": "2023-03-30T21:13:47.0327521+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": "2023-03-30T21:13:47.0327521+00:00" }, "project_status_id": "3da5efce-1fb0-45c5-afab-89fe99baf6df", "project_status_code": "sample string 10", "project_status": { "id": "8748a172-4b85-4928-91cb-c676fdeebdc2", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "5a3eab36-0871-4739-a10d-36f79577555b", "sales_organization_code": "sample string 6", "sales_organization": { "id": "ca62525a-ba63-4807-bbfd-a34d3d18fede", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "c44b22a9-d3d3-4559-834a-60b950a9554b", "db_currency_id": "ab45a46d-efe8-40fe-91e2-72c56add4961", "db_language_id": "1dd3e8e8-daca-49b4-ab02-dd3fe6488a26", "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": "2023-03-30T21:13:47.0327521+00:00" }, "code": "sample string 7", "modified_dateutc": "2023-03-30T21:13:47.0327521+00:00" }, "company_id": "27c4d5f5-4b32-4b56-b661-a8bff968e7f4", "company_code": "sample string 12", "db_address_id": "ae1dcd4e-33b7-4fb2-b70e-4f8203191327", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "5632d0d6-3241-4b3a-8240-d82d75510c62", "contact_reference_back_office": "sample string 17", "owner_user_id": "6ded34dc-4d5d-48e6-87a6-5f43e3b15860", "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": "2023-03-30T21:13:47.0327521+00:00", "date_create": "2023-03-30T21:13:47.0327521+00:00", "date_update": "2023-03-30T21:13:47.0327521+00:00", "updated_by_user_id": "7b7da5b7-2ed5-42a6-a651-3359156f9361", "customer_reference": "sample string 28", "warranty_date_until": "2023-03-30T21:13:47.0327521+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": "2023-03-30T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2023-03-30T21:13:47.0327521+00:00", "date_last_job": "2023-03-30T21:13:47.0327521+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2023-03-30T21:13:47.0327521+00:00", "modified_dateutc": "2023-03-30T21:13:47.0327521+00:00", "is_mobile_installation": true }, "job_type_id": "70e1694d-eb86-4928-898a-530f7d5e25d5", "job_type_code": "sample string 7", "job_type": { "id": "a10f7955-93d2-4210-9df0-dd99d96a61a8", "name": "sample string 2", "sales_organization_id": "a1ede0fa-bc6d-4659-96e6-3165e4b540bc", "description": "sample string 4", "is_default": true, "modified_dateutc": "2023-03-30T21:13:47.0327521+00:00", "code": "sample string 7" }, "job_priority_id": "da02c19e-3db2-4f80-89e6-c46f12c3162a", "job_priority_code": "sample string 9", "job_priority": { "id": "0429d37f-19e5-406f-a588-c2b36cce9518", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "1514c9a2-80b8-4a0c-94d1-86443e92ccb7", "sales_organization_code": "sample string 6", "sales_organization": { "id": "ca62525a-ba63-4807-bbfd-a34d3d18fede", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "c44b22a9-d3d3-4559-834a-60b950a9554b", "db_currency_id": "ab45a46d-efe8-40fe-91e2-72c56add4961", "db_language_id": "1dd3e8e8-daca-49b4-ab02-dd3fe6488a26", "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": "2023-03-30T21:13:47.0327521+00:00" }, "code": "sample string 7", "modified_dateutc": "2023-03-30T21:13:47.0327521+00:00" }, "job_status_id": "59b5ad8b-812f-488b-87e9-1c8358e42232", "job_status_code": "sample string 11", "db_address_id": "572d52fa-35bd-41ba-a4c5-4371e6ff6dd1", "contact_id": "950fc21f-ae37-4233-9d8b-6b3fb2561669", "requested_by_company_id": "e6a6df85-4bf7-4d50-a614-4bbd0a08910a", "requested_by_contact_id": "d7af9ecd-73cf-4042-9858-1cbb2fb879ab", "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": "2023-03-30T21:13:47.0327521+00:00", "due_date": "2023-03-30T21:13:47.0327521+00:00", "date_create": "2023-03-30T21:13:47.0327521+00:00", "date_update": "2023-03-30T21:13:47.0327521+00:00", "date_closed": "2023-03-30T21:13:47.0327521+00:00", "suggested_user_id": "a132ab90-f41e-42c0-8c03-e3b44462edd7", "suggested_user_code": "sample string 29", "suggested_user": { "id": "dc95f33f-4ffb-4a23-8306-f36f14a0c906", "db_language_id": "ba5137b4-1d94-4548-906b-d0555de52f3e", "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": "2023-03-30T21:13:47.0327521+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "3d626289-765e-4a0d-874e-810d9d4d6a43", "sales_organization": { "id": "ca62525a-ba63-4807-bbfd-a34d3d18fede", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "c44b22a9-d3d3-4559-834a-60b950a9554b", "db_currency_id": "ab45a46d-efe8-40fe-91e2-72c56add4961", "db_language_id": "1dd3e8e8-daca-49b4-ab02-dd3fe6488a26", "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": "2023-03-30T21:13:47.0327521+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "98f4e4eb-132e-4c43-9068-d869a453d884", "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": "357a9891-766e-405a-99bd-d8c089f7b608", "private_db_country_code": "sample string 35", "modified_dateutc": "2023-03-30T21:13:47.0327521+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "1eae3863-e636-41b2-a2c3-9a61c010a639" }, "suggested_date_start": "2023-03-30T21:13:47.0327521+00:00", "skill_id": "5d198a5a-50f9-4412-b447-b80c364da623", "skill_code": "sample string 32", "skill": { "id": "dac319cb-7b88-4353-a024-45d6e9d28f89", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "0e5249c5-28cb-4769-a829-7514719f63fe", "sales_organization_code": "sample string 6", "sales_organization": { "id": "ca62525a-ba63-4807-bbfd-a34d3d18fede", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "c44b22a9-d3d3-4559-834a-60b950a9554b", "db_currency_id": "ab45a46d-efe8-40fe-91e2-72c56add4961", "db_language_id": "1dd3e8e8-daca-49b4-ab02-dd3fe6488a26", "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": "2023-03-30T21:13:47.0327521+00:00" }, "modified_dateutc": "2023-03-30T21:13:47.0327521+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "6259fbc3-d238-4664-9152-faefd8d84ad4", "date_reported_by_company": "2023-03-30T21:13:47.0327521+00:00", "id2": 36, "company_id": "e4a196f8-015d-4611-9bb8-82ca54f3d919", "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": "fff4c578-7f00-425d-ae52-a2055fcbf916", "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": "2023-03-30T21:13:47.0327521+00:00" }