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": "8f5ee596-c0c7-4bdf-acd3-7aa9fd325f2f", "_parent_id": "a0baaf8c-ce9e-46bd-bcdf-df716df4238c", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "35ccbcd6-a428-427c-9219-24c536af1978", "project_reference_back_office": "sample string 5", "project": { "id": "6c4d463f-ae0d-4c26-98a8-c433181344c2", "_parent_id": "c8e1e6e4-2e7b-4e33-99c5-8274cd5c1072", "root_parent_id": "972607df-75ed-4067-b823-ef4f821d5187", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "d51b1007-5b53-4f21-9afa-ecc553522ef3", "equipment_family_code": "sample string 6", "equipment_family": { "id": "c2b63ce1-955d-4237-a662-5c3538ac55f2", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "456548b8-a083-45b4-9fd8-7acc6f5fa0ba", "_parent_code": "sample string 6", "sales_organization_id": "7aa6be80-ac70-4157-a21e-ce6fc33d9b46", "sales_organization_code": "sample string 8", "sales_organization": { "id": "7e277945-52a6-429b-bf45-271f71e9ac65", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "9237bb9c-64ac-432e-aa04-696d008bd01f", "db_currency_id": "3ecde8f5-b50f-45a9-b552-727c329001ba", "db_language_id": "e7876b88-466a-401e-b244-d09a8a0b8651", "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-01-22T01:09:45.6670896+00:00" }, "modified_dateutc": "2025-01-22T01:09:45.6670896+00:00" }, "equipment_model_id": "8ac53e87-0964-4f41-9d6e-858e2ee3f00a", "equipment_model_code": "sample string 8", "equipment_model": { "id": "96212bbc-159c-4b7f-8ad7-1f24737ca9a2", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "35268e76-16ff-43a0-8a92-073a93d44d65", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "a30b7362-81fe-4276-902c-3d5fb13b9b03", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "618433de-23f8-4ebf-a9a3-bf1c66b93622", "sales_organization_code": "sample string 5", "sales_organization": { "id": "7e277945-52a6-429b-bf45-271f71e9ac65", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "9237bb9c-64ac-432e-aa04-696d008bd01f", "db_currency_id": "3ecde8f5-b50f-45a9-b552-727c329001ba", "db_language_id": "e7876b88-466a-401e-b244-d09a8a0b8651", "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-01-22T01:09:45.6670896+00:00" }, "modified_dateutc": "2025-01-22T01:09:45.6670896+00:00" }, "equipment_family_id": "3aa74b5a-4cb7-46b1-b377-adaa0cef4be1", "equipment_family_code": "sample string 8", "equipment_family": { "id": "c2b63ce1-955d-4237-a662-5c3538ac55f2", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "456548b8-a083-45b4-9fd8-7acc6f5fa0ba", "_parent_code": "sample string 6", "sales_organization_id": "7aa6be80-ac70-4157-a21e-ce6fc33d9b46", "sales_organization_code": "sample string 8", "sales_organization": { "id": "7e277945-52a6-429b-bf45-271f71e9ac65", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "9237bb9c-64ac-432e-aa04-696d008bd01f", "db_currency_id": "3ecde8f5-b50f-45a9-b552-727c329001ba", "db_language_id": "e7876b88-466a-401e-b244-d09a8a0b8651", "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-01-22T01:09:45.6670896+00:00" }, "modified_dateutc": "2025-01-22T01:09:45.6670896+00:00" }, "date_in_production_since": "2025-01-22T01:09:45.6670896+00:00", "date_out_of_production_since": "2025-01-22T01:09:45.6670896+00:00", "date_end_support": "2025-01-22T01:09:45.6670896+00:00", "sales_organization_id": "8519fd00-cd03-4379-8ca5-8c21f9432902", "sales_organization_code": "sample string 13", "sales_organization": { "id": "7e277945-52a6-429b-bf45-271f71e9ac65", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "9237bb9c-64ac-432e-aa04-696d008bd01f", "db_currency_id": "3ecde8f5-b50f-45a9-b552-727c329001ba", "db_language_id": "e7876b88-466a-401e-b244-d09a8a0b8651", "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-01-22T01:09:45.6670896+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-01-22T01:09:45.6670896+00:00" }, "project_status_id": "70c6b22c-63b4-43ba-904d-d00a8dd82c7c", "project_status_code": "sample string 10", "project_status": { "id": "f045b220-d6a2-4309-a2ea-8c0fbefbb583", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "b9c117f7-bafb-46f2-a2b8-1f7b53d9dfc9", "sales_organization_code": "sample string 6", "sales_organization": { "id": "7e277945-52a6-429b-bf45-271f71e9ac65", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "9237bb9c-64ac-432e-aa04-696d008bd01f", "db_currency_id": "3ecde8f5-b50f-45a9-b552-727c329001ba", "db_language_id": "e7876b88-466a-401e-b244-d09a8a0b8651", "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-01-22T01:09:45.6670896+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-01-22T01:09:45.6670896+00:00" }, "company_id": "77d9c89c-86bc-4b8a-a1b4-3419816172e0", "company_code": "sample string 12", "db_address_id": "1e7a1156-5f51-453f-84d5-2708e2c02604", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "dcdb19ee-54e0-4260-9477-69e77c023efe", "contact_reference_back_office": "sample string 17", "owner_user_id": "9e439337-a081-4d95-9443-cfdf494c93d4", "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-01-22T01:09:45.6670896+00:00", "date_create": "2025-01-22T01:09:45.6670896+00:00", "date_update": "2025-01-22T01:09:45.6670896+00:00", "updated_by_user_id": "bc9971c9-93eb-4dfb-b72f-a40e9e58b4f8", "customer_reference": "sample string 28", "warranty_date_until": "2025-01-22T01:09:45.6670896+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-01-22T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-01-22T01:09:45.6670896+00:00", "date_last_job": "2025-01-22T01:09:45.6670896+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-01-22T01:09:45.6670896+00:00", "modified_dateutc": "2025-01-22T01:09:45.6670896+00:00", "is_mobile_installation": true }, "job_type_id": "cd573285-aa49-4815-9af2-0aafc2d8bce3", "job_type_code": "sample string 7", "job_type": { "id": "d02acde5-df18-42fc-b489-deec5bfb1637", "name": "sample string 2", "sales_organization_id": "a170345c-5273-43e8-9adf-034c57520f7d", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-01-22T01:09:45.6670896+00:00", "code": "sample string 7" }, "job_priority_id": "bb4b1f37-d022-4312-846a-324150c0ba08", "job_priority_code": "sample string 9", "job_priority": { "id": "74080cf6-8914-4279-b15c-d35a02a4107e", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "c4d4096d-d10a-49af-b240-6cec192fd30b", "sales_organization_code": "sample string 6", "sales_organization": { "id": "7e277945-52a6-429b-bf45-271f71e9ac65", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "9237bb9c-64ac-432e-aa04-696d008bd01f", "db_currency_id": "3ecde8f5-b50f-45a9-b552-727c329001ba", "db_language_id": "e7876b88-466a-401e-b244-d09a8a0b8651", "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-01-22T01:09:45.6670896+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-01-22T01:09:45.6670896+00:00" }, "job_status_id": "094f31e4-669d-4276-8624-e1ce3f88c184", "job_status_code": "sample string 11", "db_address_id": "5f08d448-d5f3-4f46-9437-5efb3100f9d8", "contact_id": "a74bf84e-d2f7-4dbd-ba0e-0ab06dc209cb", "requested_by_company_id": "2f4bdcf0-63ea-4c95-96a0-76ca23667635", "requested_by_contact_id": "f2327925-a648-4d83-9729-0deaac3254bd", "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-01-22T01:09:45.6670896+00:00", "due_date": "2025-01-22T01:09:45.6670896+00:00", "date_create": "2025-01-22T01:09:45.6670896+00:00", "date_update": "2025-01-22T01:09:45.6670896+00:00", "date_closed": "2025-01-22T01:09:45.6670896+00:00", "suggested_user_id": "4ae4b369-0ecb-47ae-93fe-0496edbbb01b", "suggested_user_code": "sample string 29", "suggested_user": { "id": "869acbf0-d076-4416-bb07-07ebcdde101c", "db_language_id": "609b6590-8222-4194-a7f6-297c8afa7f38", "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-01-22T01:09:45.6670896+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "c3dcbfe4-a5e6-4136-b26c-1a526a88666c", "sales_organization": { "id": "7e277945-52a6-429b-bf45-271f71e9ac65", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "9237bb9c-64ac-432e-aa04-696d008bd01f", "db_currency_id": "3ecde8f5-b50f-45a9-b552-727c329001ba", "db_language_id": "e7876b88-466a-401e-b244-d09a8a0b8651", "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-01-22T01:09:45.6670896+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "0bfd633e-165e-48dc-b26e-69bc1d687531", "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": "0872f444-a9d0-4505-96a0-47e5149ced6c", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-01-22T01:09:45.6670896+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "5223581b-528d-4bb2-b31c-b82c16001b57" }, "suggested_date_start": "2025-01-22T01:09:45.6670896+00:00", "skill_id": "37201ed2-a521-4d13-8359-fabe6e5bd5d2", "skill_code": "sample string 32", "skill": { "id": "702e4ede-5ad4-42e3-bfd9-def62a981323", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "ecf113e3-2dfc-485b-8ecd-348c4af04a13", "sales_organization_code": "sample string 6", "sales_organization": { "id": "7e277945-52a6-429b-bf45-271f71e9ac65", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "9237bb9c-64ac-432e-aa04-696d008bd01f", "db_currency_id": "3ecde8f5-b50f-45a9-b552-727c329001ba", "db_language_id": "e7876b88-466a-401e-b244-d09a8a0b8651", "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-01-22T01:09:45.6670896+00:00" }, "modified_dateutc": "2025-01-22T01:09:45.6670896+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "6c433919-34ab-4645-9427-f5385201f7ae", "date_reported_by_company": "2025-01-22T01:09:45.6670896+00:00", "id2": 36, "company_id": "96849d87-25bd-47bc-a6bd-8acc246c0ada", "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": "daaab9d3-dc0f-4f16-b909-03b49b81d143", "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-01-22T01:09:45.6670896+00:00" }