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": "33d24053-14de-4e02-b872-eec88ea5e130", "_parent_id": "dae7ea04-88ff-40fb-99ca-1f136d888462", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "52585018-c9de-448a-8273-60485f24c699", "project_reference_back_office": "sample string 5", "project": { "id": "6d6e2d26-1cb3-4526-bdf5-86f2e8bc57f4", "_parent_id": "714ea9dc-a4da-4b85-8e9c-4a720f64d6ba", "root_parent_id": "fec4dc0c-4c10-4f5d-af33-95c9619a49fd", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "ef679ab1-2c71-405a-a4eb-cce401f8b78f", "equipment_family_code": "sample string 6", "equipment_family": { "id": "ec84fa1f-5b76-421b-b730-0136c20a3ea9", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "f113f482-7972-47c8-925b-750985b9281c", "_parent_code": "sample string 6", "sales_organization_id": "d252cda2-f2c2-46e0-a94b-98576c94d560", "sales_organization_code": "sample string 8", "sales_organization": { "id": "ce273287-45da-4710-b896-dfa87c0763d0", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "b1010ee7-ddf8-4780-bb75-97f361f3b340", "db_currency_id": "19d2edfa-fe5a-4c16-855e-ed49164cba22", "db_language_id": "f07ad869-4114-487b-b5ab-3f3070fc0ec4", "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:50:47.5058191+00:00" }, "modified_dateutc": "2025-06-21T11:50:47.5058191+00:00" }, "equipment_model_id": "6965b1b2-8497-4397-8ead-822618fc4594", "equipment_model_code": "sample string 8", "equipment_model": { "id": "63de44ff-7f20-41b1-b69e-d17f444d0878", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "4517c400-aa5e-41b0-b4ee-c293bc393d55", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "9d0ce1ff-d6c2-4d90-9ed1-f413afc570c3", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "7de3011a-155b-45a4-bb23-119cc7eb0bce", "sales_organization_code": "sample string 5", "sales_organization": { "id": "ce273287-45da-4710-b896-dfa87c0763d0", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "b1010ee7-ddf8-4780-bb75-97f361f3b340", "db_currency_id": "19d2edfa-fe5a-4c16-855e-ed49164cba22", "db_language_id": "f07ad869-4114-487b-b5ab-3f3070fc0ec4", "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:50:47.5058191+00:00" }, "modified_dateutc": "2025-06-21T11:50:47.5058191+00:00" }, "equipment_family_id": "f5a515b0-2593-4aac-addc-71ec21050bd2", "equipment_family_code": "sample string 8", "equipment_family": { "id": "ec84fa1f-5b76-421b-b730-0136c20a3ea9", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "f113f482-7972-47c8-925b-750985b9281c", "_parent_code": "sample string 6", "sales_organization_id": "d252cda2-f2c2-46e0-a94b-98576c94d560", "sales_organization_code": "sample string 8", "sales_organization": { "id": "ce273287-45da-4710-b896-dfa87c0763d0", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "b1010ee7-ddf8-4780-bb75-97f361f3b340", "db_currency_id": "19d2edfa-fe5a-4c16-855e-ed49164cba22", "db_language_id": "f07ad869-4114-487b-b5ab-3f3070fc0ec4", "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:50:47.5058191+00:00" }, "modified_dateutc": "2025-06-21T11:50:47.5058191+00:00" }, "date_in_production_since": "2025-06-21T11:50:47.5058191+00:00", "date_out_of_production_since": "2025-06-21T11:50:47.5058191+00:00", "date_end_support": "2025-06-21T11:50:47.5058191+00:00", "sales_organization_id": "e92d5314-ed1f-487f-9066-179e889e8ed8", "sales_organization_code": "sample string 13", "sales_organization": { "id": "ce273287-45da-4710-b896-dfa87c0763d0", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "b1010ee7-ddf8-4780-bb75-97f361f3b340", "db_currency_id": "19d2edfa-fe5a-4c16-855e-ed49164cba22", "db_language_id": "f07ad869-4114-487b-b5ab-3f3070fc0ec4", "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:50:47.5058191+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:50:47.5058191+00:00" }, "project_status_id": "e93b3c93-89ff-43bc-84ad-a34d275cc5a2", "project_status_code": "sample string 10", "project_status": { "id": "2c5ff3b2-8bc8-4255-9d97-c3ee0521a31f", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "9fc7afc4-c85e-4784-9d6d-9a8f0fa1c83e", "sales_organization_code": "sample string 6", "sales_organization": { "id": "ce273287-45da-4710-b896-dfa87c0763d0", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "b1010ee7-ddf8-4780-bb75-97f361f3b340", "db_currency_id": "19d2edfa-fe5a-4c16-855e-ed49164cba22", "db_language_id": "f07ad869-4114-487b-b5ab-3f3070fc0ec4", "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:50:47.5058191+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-06-21T11:50:47.5058191+00:00" }, "company_id": "d94489af-205a-4c47-ac13-fd2520ebc14a", "company_code": "sample string 12", "db_address_id": "6d488e0d-1591-42bb-8b38-3f3058b1cff2", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "5cd8217e-8cab-49f7-ade1-84bb1cb1b33d", "contact_reference_back_office": "sample string 17", "owner_user_id": "32662fd1-c8f9-41bd-bb17-b8b777839a02", "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:50:47.5058191+00:00", "date_create": "2025-06-21T11:50:47.5058191+00:00", "date_update": "2025-06-21T11:50:47.5058191+00:00", "updated_by_user_id": "ac610f31-20cc-48b8-aa56-29da4dc71191", "customer_reference": "sample string 28", "warranty_date_until": "2025-06-21T11:50:47.5058191+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:50:47.5058191+00:00", "date_last_job": "2025-06-21T11:50:47.5058191+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-06-21T11:50:47.5058191+00:00", "modified_dateutc": "2025-06-21T11:50:47.5058191+00:00", "is_mobile_installation": true }, "job_type_id": "c164facd-189a-4d4f-bc6d-8d58c1cf817c", "job_type_code": "sample string 7", "job_type": { "id": "72eae41b-5b79-488e-9201-0475f6d552c9", "name": "sample string 2", "sales_organization_id": "b9431b26-8d45-4ff7-9a39-2b870accd7a9", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-06-21T11:50:47.5058191+00:00", "code": "sample string 7" }, "job_priority_id": "c3abd29d-67fc-478e-99e0-3c5074580cc7", "job_priority_code": "sample string 9", "job_priority": { "id": "5925d18a-c41a-429b-9f17-941596464b80", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "730d84de-80cb-4b33-91f6-f04f215b45f0", "sales_organization_code": "sample string 6", "sales_organization": { "id": "ce273287-45da-4710-b896-dfa87c0763d0", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "b1010ee7-ddf8-4780-bb75-97f361f3b340", "db_currency_id": "19d2edfa-fe5a-4c16-855e-ed49164cba22", "db_language_id": "f07ad869-4114-487b-b5ab-3f3070fc0ec4", "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:50:47.5058191+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-06-21T11:50:47.5058191+00:00" }, "job_status_id": "869cde45-3258-4636-8e52-0081cf63ae9c", "job_status_code": "sample string 11", "db_address_id": "29a2784b-63dd-40e7-a888-e1c03f1daafb", "contact_id": "e7dae468-7165-4862-b96f-33938fc75f74", "requested_by_company_id": "eff366a3-7eb0-48d1-8f37-a947f45fb17f", "requested_by_contact_id": "33092bc8-f519-4c8f-b086-3bc7f4a28064", "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:50:47.5058191+00:00", "due_date": "2025-06-21T11:50:47.5058191+00:00", "date_create": "2025-06-21T11:50:47.5058191+00:00", "date_update": "2025-06-21T11:50:47.5058191+00:00", "date_closed": "2025-06-21T11:50:47.5058191+00:00", "suggested_user_id": "5b59cb54-b690-43e4-8edd-9822e68ff39d", "suggested_user_code": "sample string 29", "suggested_user": { "id": "46d02095-ab13-412f-80ce-4b1ee48dea27", "db_language_id": "5da9d5d8-4cc1-4410-85de-203e914cc082", "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:50:47.5058191+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "31865c77-4bf6-46e1-97e7-135f4a830825", "sales_organization": { "id": "ce273287-45da-4710-b896-dfa87c0763d0", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "b1010ee7-ddf8-4780-bb75-97f361f3b340", "db_currency_id": "19d2edfa-fe5a-4c16-855e-ed49164cba22", "db_language_id": "f07ad869-4114-487b-b5ab-3f3070fc0ec4", "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:50:47.5058191+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "ab65e07a-58b4-4bd4-b896-2f371f0215ba", "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": "c6f0bc23-efda-45b9-8fc0-a540e20162ec", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-06-21T11:50:47.5058191+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "62d6c3ac-226c-470b-aa4b-dff6daa4fe2e" }, "suggested_date_start": "2025-06-21T11:50:47.5058191+00:00", "skill_id": "aab079a4-ca84-4c67-8927-a29a96bf0e4d", "skill_code": "sample string 32", "skill": { "id": "aa0853b8-5412-4977-9e95-5060638dc9bd", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "6ae6daca-c1eb-4352-8eb9-3f90ac20315b", "sales_organization_code": "sample string 6", "sales_organization": { "id": "ce273287-45da-4710-b896-dfa87c0763d0", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "b1010ee7-ddf8-4780-bb75-97f361f3b340", "db_currency_id": "19d2edfa-fe5a-4c16-855e-ed49164cba22", "db_language_id": "f07ad869-4114-487b-b5ab-3f3070fc0ec4", "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:50:47.5058191+00:00" }, "modified_dateutc": "2025-06-21T11:50:47.5058191+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "8f26cd8e-e8a3-434d-af72-34fe6a3f79e4", "date_reported_by_company": "2025-06-21T11:50:47.5058191+00:00", "id2": 36, "company_id": "618f06c4-069c-446f-b03b-26c8e2cba4b8", "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": "d9b668bd-f675-4346-8073-4a0d9e0389d8", "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:50:47.5058191+00:00" }