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": "cd3e9dd9-4448-4e51-a8b0-081727e7b178", "_parent_id": "44c7ede4-4bfe-4a53-87cc-ad97061b43c6", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "789adc59-d341-4625-8f0a-d82925166774", "project_reference_back_office": "sample string 5", "project": { "id": "24c91236-b2c1-4c08-90ef-b001a623c35c", "_parent_id": "ab4527f4-c948-48d9-ac71-bb00323fe4f0", "root_parent_id": "5e22a595-7331-4aca-9964-119dc371d517", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "7e52255b-fdad-4db4-abd3-9798082c0f1f", "equipment_family_code": "sample string 6", "equipment_family": { "id": "7ca3a53a-ea75-4ec7-ac27-58fd694c4ba4", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "ea1cd4fd-476f-4cd3-8925-83f9cff4a75d", "_parent_code": "sample string 6", "sales_organization_id": "0c451a7e-e5e0-41ce-abb6-af192c1f95bb", "sales_organization_code": "sample string 8", "sales_organization": { "id": "bfe71751-b8a0-482d-a290-7e43482239d5", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "24b47010-e3f2-4a59-ac4f-3084044d5eb5", "db_currency_id": "879a3e40-6c58-4a49-8faf-e72fe92f87de", "db_language_id": "8bb6df8d-79a5-4eb0-87e8-0b8dc3dc7ada", "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-03-19T22:37:59.5353704+00:00" }, "modified_dateutc": "2025-03-19T22:37:59.5353704+00:00" }, "equipment_model_id": "909c941d-57c5-453e-828c-1327f878474a", "equipment_model_code": "sample string 8", "equipment_model": { "id": "c05fd27d-04f7-4939-828e-9ba67506cd95", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "994d69e6-823b-430e-8138-0acc3eb3f919", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "c93804e5-6941-4f5f-b4e0-bc3dc4a43e84", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "c003d03f-2821-4bdc-9267-2d35efbc1929", "sales_organization_code": "sample string 5", "sales_organization": { "id": "bfe71751-b8a0-482d-a290-7e43482239d5", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "24b47010-e3f2-4a59-ac4f-3084044d5eb5", "db_currency_id": "879a3e40-6c58-4a49-8faf-e72fe92f87de", "db_language_id": "8bb6df8d-79a5-4eb0-87e8-0b8dc3dc7ada", "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-03-19T22:37:59.5353704+00:00" }, "modified_dateutc": "2025-03-19T22:37:59.5353704+00:00" }, "equipment_family_id": "9dce2692-8ae9-4214-bed6-d3106705232d", "equipment_family_code": "sample string 8", "equipment_family": { "id": "7ca3a53a-ea75-4ec7-ac27-58fd694c4ba4", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "ea1cd4fd-476f-4cd3-8925-83f9cff4a75d", "_parent_code": "sample string 6", "sales_organization_id": "0c451a7e-e5e0-41ce-abb6-af192c1f95bb", "sales_organization_code": "sample string 8", "sales_organization": { "id": "bfe71751-b8a0-482d-a290-7e43482239d5", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "24b47010-e3f2-4a59-ac4f-3084044d5eb5", "db_currency_id": "879a3e40-6c58-4a49-8faf-e72fe92f87de", "db_language_id": "8bb6df8d-79a5-4eb0-87e8-0b8dc3dc7ada", "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-03-19T22:37:59.5353704+00:00" }, "modified_dateutc": "2025-03-19T22:37:59.5353704+00:00" }, "date_in_production_since": "2025-03-19T22:37:59.5353704+00:00", "date_out_of_production_since": "2025-03-19T22:37:59.5353704+00:00", "date_end_support": "2025-03-19T22:37:59.5353704+00:00", "sales_organization_id": "d5be6904-5c75-44d4-b249-2a56da0c0abe", "sales_organization_code": "sample string 13", "sales_organization": { "id": "bfe71751-b8a0-482d-a290-7e43482239d5", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "24b47010-e3f2-4a59-ac4f-3084044d5eb5", "db_currency_id": "879a3e40-6c58-4a49-8faf-e72fe92f87de", "db_language_id": "8bb6df8d-79a5-4eb0-87e8-0b8dc3dc7ada", "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-03-19T22:37:59.5353704+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-03-19T22:37:59.5666196+00:00" }, "project_status_id": "902f433e-fb96-4a7f-bcf4-59738eb0776b", "project_status_code": "sample string 10", "project_status": { "id": "19ff0c10-4136-4e96-a701-69a665799fef", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "cc5dc7fd-2f2e-46d2-a1fb-1f4908f4ca6d", "sales_organization_code": "sample string 6", "sales_organization": { "id": "bfe71751-b8a0-482d-a290-7e43482239d5", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "24b47010-e3f2-4a59-ac4f-3084044d5eb5", "db_currency_id": "879a3e40-6c58-4a49-8faf-e72fe92f87de", "db_language_id": "8bb6df8d-79a5-4eb0-87e8-0b8dc3dc7ada", "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-03-19T22:37:59.5353704+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-03-19T22:37:59.5666196+00:00" }, "company_id": "2613b34e-f16d-404f-8df3-80718369a3fc", "company_code": "sample string 12", "db_address_id": "5089272d-7414-4bda-97d7-eef10e867f62", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "f4e9ee9b-a611-429d-b4cd-fa3b3258e2a0", "contact_reference_back_office": "sample string 17", "owner_user_id": "f50633d4-1dbd-438a-bb6c-881a8a87e6ce", "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-03-19T22:37:59.5666196+00:00", "date_create": "2025-03-19T22:37:59.5666196+00:00", "date_update": "2025-03-19T22:37:59.5666196+00:00", "updated_by_user_id": "a5f39949-b9e6-40fc-a880-32b37d10fa51", "customer_reference": "sample string 28", "warranty_date_until": "2025-03-19T22:37:59.5666196+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-03-19T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-03-19T22:37:59.5666196+00:00", "date_last_job": "2025-03-19T22:37:59.5666196+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-03-19T22:37:59.5666196+00:00", "modified_dateutc": "2025-03-19T22:37:59.5666196+00:00", "is_mobile_installation": true }, "job_type_id": "90998b8b-bab3-4afc-aac3-da37e44409bf", "job_type_code": "sample string 7", "job_type": { "id": "95ac9d15-24f3-4cd2-9978-012f61881bbd", "name": "sample string 2", "sales_organization_id": "75aae211-23e5-4f18-a3ae-1de3417e1261", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-03-19T22:37:59.5666196+00:00", "code": "sample string 7" }, "job_priority_id": "9b4c16c1-4a12-461f-88fa-77e61e15d32a", "job_priority_code": "sample string 9", "job_priority": { "id": "45043a99-390d-4f29-95e8-1e6b8aa5e533", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "96234173-7794-4fca-af03-87cc35fc2575", "sales_organization_code": "sample string 6", "sales_organization": { "id": "bfe71751-b8a0-482d-a290-7e43482239d5", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "24b47010-e3f2-4a59-ac4f-3084044d5eb5", "db_currency_id": "879a3e40-6c58-4a49-8faf-e72fe92f87de", "db_language_id": "8bb6df8d-79a5-4eb0-87e8-0b8dc3dc7ada", "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-03-19T22:37:59.5353704+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-03-19T22:37:59.5666196+00:00" }, "job_status_id": "511fe699-1df9-45c0-937e-86e7246a3048", "job_status_code": "sample string 11", "db_address_id": "098858e7-818c-4010-bfca-75672f6ed753", "contact_id": "dd428a1b-d4b0-458d-84b3-402246d896d5", "requested_by_company_id": "f6ae8d33-2eae-42dc-9d9a-37a544dbc89a", "requested_by_contact_id": "397fc2ed-b669-4302-8910-5ca36491655e", "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-03-19T22:37:59.5666196+00:00", "due_date": "2025-03-19T22:37:59.5666196+00:00", "date_create": "2025-03-19T22:37:59.5666196+00:00", "date_update": "2025-03-19T22:37:59.5666196+00:00", "date_closed": "2025-03-19T22:37:59.5666196+00:00", "suggested_user_id": "56232d0a-2037-4f45-9d24-6a57928eb65c", "suggested_user_code": "sample string 29", "suggested_user": { "id": "2be1f944-b103-4baa-b79f-0fe5b28541d7", "db_language_id": "eb1f25bd-11d2-48ab-a7f1-3d5d70865266", "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-03-19T22:37:59.5666196+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "647bd64c-e67b-4eef-8c67-9f9b0a1dbf61", "sales_organization": { "id": "bfe71751-b8a0-482d-a290-7e43482239d5", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "24b47010-e3f2-4a59-ac4f-3084044d5eb5", "db_currency_id": "879a3e40-6c58-4a49-8faf-e72fe92f87de", "db_language_id": "8bb6df8d-79a5-4eb0-87e8-0b8dc3dc7ada", "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-03-19T22:37:59.5353704+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "cab71f8c-982d-4694-9168-ebd0c2bc2742", "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": "6cfd87c7-ae00-4dd3-85af-4302a96db45a", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-03-19T22:37:59.5666196+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "45ef0524-2973-43fd-b62a-63bc6fefccbb" }, "suggested_date_start": "2025-03-19T22:37:59.5666196+00:00", "skill_id": "b02f66b4-cf56-407f-8832-6430e9111eef", "skill_code": "sample string 32", "skill": { "id": "288e0b32-854d-4fe2-8f57-86b990d0cf6d", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "17a830de-79a6-4aec-85b2-f4c9e7000590", "sales_organization_code": "sample string 6", "sales_organization": { "id": "bfe71751-b8a0-482d-a290-7e43482239d5", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "24b47010-e3f2-4a59-ac4f-3084044d5eb5", "db_currency_id": "879a3e40-6c58-4a49-8faf-e72fe92f87de", "db_language_id": "8bb6df8d-79a5-4eb0-87e8-0b8dc3dc7ada", "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-03-19T22:37:59.5353704+00:00" }, "modified_dateutc": "2025-03-19T22:37:59.5666196+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "fd5316bf-eeeb-4568-8b5a-16f572eb1d4b", "date_reported_by_company": "2025-03-19T22:37:59.5666196+00:00", "id2": 36, "company_id": "9052ee7d-a083-470e-90d5-d85ff9a2e4fb", "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": "0449efdf-24a9-48a4-baaa-c7d2017996aa", "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-03-19T22:37:59.5666196+00:00" }
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.