Creates a new work order
Request Information
URI Parameters :
None.
Body Parameters :
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 |
Request Formats :
application/json, text/json
{ "id": "05fdaa7b-070f-4294-9223-1b2b741940cd", "_parent_id": "e5719ab0-da12-4b45-ab8f-7a6e289aab46", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "97901e68-b4c7-4d34-bfc3-ff95a00f0fa7", "project_reference_back_office": "sample string 5", "project": { "id": "4634b30d-1028-4d43-b5a4-ed67de2f570c", "_parent_id": "1abd9dad-3365-40db-807e-70c4b694d859", "root_parent_id": "56208a65-0a1e-45df-ae81-cbbcfe12cff2", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "10b526cf-ce61-4e37-baa9-4e075a94426f", "equipment_family_code": "sample string 6", "equipment_family": { "id": "5808da62-ba04-4ae7-a4ad-0a458752aa85", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "8db34132-0c48-4593-b9b8-205d4dee4b3b", "_parent_code": "sample string 6", "sales_organization_id": "35aebb11-3a83-4787-bec4-e2746987602c", "sales_organization_code": "sample string 8", "sales_organization": { "id": "3c204b2a-5e48-4180-bda8-589b7c9a90e6", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "54016428-7ceb-477f-ad63-5705a4165552", "db_currency_id": "5495cf7e-8db4-4b52-bc15-511e5f11bcd1", "db_language_id": "32b674ad-beb0-4696-a959-7e0afbc8778d", "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-02-05T06:51:49.9374745+00:00" }, "modified_dateutc": "2025-02-05T06:51:49.9374745+00:00" }, "equipment_model_id": "c7ac7335-4eb8-4517-8e41-f422e2c9965b", "equipment_model_code": "sample string 8", "equipment_model": { "id": "533b5713-c9ba-4184-b6b9-03262e71ce2e", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "1976a08b-1b26-4eff-b18c-12daa2ba5d06", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "64f8a2b2-7226-4b23-b052-b3a57910bb90", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "0ed9df39-b1f7-472d-8e36-740391e96d02", "sales_organization_code": "sample string 5", "sales_organization": { "id": "3c204b2a-5e48-4180-bda8-589b7c9a90e6", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "54016428-7ceb-477f-ad63-5705a4165552", "db_currency_id": "5495cf7e-8db4-4b52-bc15-511e5f11bcd1", "db_language_id": "32b674ad-beb0-4696-a959-7e0afbc8778d", "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-02-05T06:51:49.9374745+00:00" }, "modified_dateutc": "2025-02-05T06:51:49.9374745+00:00" }, "equipment_family_id": "b0c7297b-e749-46e9-af8f-5f19f7ad5d22", "equipment_family_code": "sample string 8", "equipment_family": { "id": "5808da62-ba04-4ae7-a4ad-0a458752aa85", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "8db34132-0c48-4593-b9b8-205d4dee4b3b", "_parent_code": "sample string 6", "sales_organization_id": "35aebb11-3a83-4787-bec4-e2746987602c", "sales_organization_code": "sample string 8", "sales_organization": { "id": "3c204b2a-5e48-4180-bda8-589b7c9a90e6", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "54016428-7ceb-477f-ad63-5705a4165552", "db_currency_id": "5495cf7e-8db4-4b52-bc15-511e5f11bcd1", "db_language_id": "32b674ad-beb0-4696-a959-7e0afbc8778d", "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-02-05T06:51:49.9374745+00:00" }, "modified_dateutc": "2025-02-05T06:51:49.9374745+00:00" }, "date_in_production_since": "2025-02-05T06:51:49.9374745+00:00", "date_out_of_production_since": "2025-02-05T06:51:49.9374745+00:00", "date_end_support": "2025-02-05T06:51:49.9374745+00:00", "sales_organization_id": "8696961c-146e-4c43-9241-4ade9db92959", "sales_organization_code": "sample string 13", "sales_organization": { "id": "3c204b2a-5e48-4180-bda8-589b7c9a90e6", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "54016428-7ceb-477f-ad63-5705a4165552", "db_currency_id": "5495cf7e-8db4-4b52-bc15-511e5f11bcd1", "db_language_id": "32b674ad-beb0-4696-a959-7e0afbc8778d", "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-02-05T06:51:49.9374745+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-02-05T06:51:49.9374745+00:00" }, "project_status_id": "da79d799-5122-48d5-a7a7-e53074eb86e2", "project_status_code": "sample string 10", "project_status": { "id": "c659b3c0-97e5-46f5-b62f-74553e694603", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "7aefb7a5-b279-4508-8941-e5d0feda3d69", "sales_organization_code": "sample string 6", "sales_organization": { "id": "3c204b2a-5e48-4180-bda8-589b7c9a90e6", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "54016428-7ceb-477f-ad63-5705a4165552", "db_currency_id": "5495cf7e-8db4-4b52-bc15-511e5f11bcd1", "db_language_id": "32b674ad-beb0-4696-a959-7e0afbc8778d", "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-02-05T06:51:49.9374745+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-02-05T06:51:49.9374745+00:00" }, "company_id": "8f3a4236-d039-4a97-aa70-fa8a27704914", "company_code": "sample string 12", "db_address_id": "1b692010-000e-4289-a75a-b260d26bc14e", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "ce43f3c8-154a-4951-ae68-a0a87cda7c07", "contact_reference_back_office": "sample string 17", "owner_user_id": "297b3bf7-f3f1-458a-a6e2-edc545ea7031", "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-02-05T06:51:49.9374745+00:00", "date_create": "2025-02-05T06:51:49.9374745+00:00", "date_update": "2025-02-05T06:51:49.9374745+00:00", "updated_by_user_id": "265f131b-2f73-4933-ab7e-021d6f07d3db", "customer_reference": "sample string 28", "warranty_date_until": "2025-02-05T06:51:49.9374745+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-02-05T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-02-05T06:51:49.9374745+00:00", "date_last_job": "2025-02-05T06:51:49.9374745+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-02-05T06:51:49.9374745+00:00", "modified_dateutc": "2025-02-05T06:51:49.9374745+00:00", "is_mobile_installation": true }, "job_type_id": "7b2fed2d-d991-4f42-a568-249b0750029a", "job_type_code": "sample string 7", "job_type": { "id": "9f015802-544d-4719-b54a-b403d74204d8", "name": "sample string 2", "sales_organization_id": "19144121-fb42-4ce9-9ebc-42b725047ee5", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-02-05T06:51:49.9374745+00:00", "code": "sample string 7" }, "job_priority_id": "e83b90a6-7477-4cab-a109-e33a3e1468bf", "job_priority_code": "sample string 9", "job_priority": { "id": "5e8b7bfd-ecb8-4f3a-aa1a-bdef1c55e216", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "1b701eb0-412b-4f74-9480-a53a5a8201f6", "sales_organization_code": "sample string 6", "sales_organization": { "id": "3c204b2a-5e48-4180-bda8-589b7c9a90e6", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "54016428-7ceb-477f-ad63-5705a4165552", "db_currency_id": "5495cf7e-8db4-4b52-bc15-511e5f11bcd1", "db_language_id": "32b674ad-beb0-4696-a959-7e0afbc8778d", "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-02-05T06:51:49.9374745+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-02-05T06:51:49.9374745+00:00" }, "job_status_id": "02dedc63-3188-4fc7-92af-57b24b51297f", "job_status_code": "sample string 11", "db_address_id": "fd5badc1-469d-4cd0-8c78-71a15ac09243", "contact_id": "f169b5e0-8648-43c5-85ea-7afb0fde338a", "requested_by_company_id": "e36fddb8-0651-4f3d-8ae6-a01b7fc97b5e", "requested_by_contact_id": "9c644dde-e9b9-489e-a8e3-4cb5dbda238e", "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-02-05T06:51:49.9374745+00:00", "due_date": "2025-02-05T06:51:49.9374745+00:00", "date_create": "2025-02-05T06:51:49.9374745+00:00", "date_update": "2025-02-05T06:51:49.9374745+00:00", "date_closed": "2025-02-05T06:51:49.9374745+00:00", "suggested_user_id": "5366cf4c-df77-4e51-90f6-61bc8334ed03", "suggested_user_code": "sample string 29", "suggested_user": { "id": "17be314b-5b25-48bf-a235-f74be52a1e15", "db_language_id": "096789a9-54ff-4d8d-8b44-75120e57883f", "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-02-05T06:51:49.9374745+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "8b10b93c-4bb1-4ab1-a23c-f7720960bd21", "sales_organization": { "id": "3c204b2a-5e48-4180-bda8-589b7c9a90e6", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "54016428-7ceb-477f-ad63-5705a4165552", "db_currency_id": "5495cf7e-8db4-4b52-bc15-511e5f11bcd1", "db_language_id": "32b674ad-beb0-4696-a959-7e0afbc8778d", "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-02-05T06:51:49.9374745+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "0d746a00-7bc7-48f9-973a-eb86ff9300dc", "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": "8c34b712-9aa4-4ab0-88d3-ac9b3c6d47fa", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-02-05T06:51:49.9374745+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "1e2d42f8-5318-4e2d-baa5-70c31494b8c2" }, "suggested_date_start": "2025-02-05T06:51:49.9374745+00:00", "skill_id": "23663643-2753-4ed4-91c5-5e076dc445b2", "skill_code": "sample string 32", "skill": { "id": "c410122e-6577-4307-885a-a7a8189947e0", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "e3b82817-94b1-4a39-8a5c-c28604b67ae4", "sales_organization_code": "sample string 6", "sales_organization": { "id": "3c204b2a-5e48-4180-bda8-589b7c9a90e6", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "54016428-7ceb-477f-ad63-5705a4165552", "db_currency_id": "5495cf7e-8db4-4b52-bc15-511e5f11bcd1", "db_language_id": "32b674ad-beb0-4696-a959-7e0afbc8778d", "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-02-05T06:51:49.9374745+00:00" }, "modified_dateutc": "2025-02-05T06:51:49.9374745+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "9ad0531d-5574-4d2f-a822-998807ffb071", "date_reported_by_company": "2025-02-05T06:51:49.9374745+00:00", "id2": 36, "company_id": "6d0cbf7c-7523-48bc-bf86-ae5f722165d2", "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": "c8a69a94-ed86-41b3-a6ad-4f6e6f990477", "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-02-05T06:51:49.9374745+00:00" }
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.