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": "425a0c9e-af67-49e5-8c0a-b63891b475dc", "_parent_id": "2c0a762d-beac-4e52-91ac-2624f882ead6", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "f5fb5faf-eb31-498d-a2f9-028fb9779aae", "project_reference_back_office": "sample string 5", "project": { "id": "9c55d568-49c1-48e1-99f6-abcb1891aff2", "_parent_id": "f96a01e3-e0e3-44dd-be7c-4fcd66c49d0a", "root_parent_id": "8d029e71-98ba-4b97-9221-c81c3075a88e", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "2790a842-fbd2-4470-ac97-7e8928f4eb12", "equipment_family_code": "sample string 6", "equipment_family": { "id": "8e19fe27-70e4-46fa-ad2f-528c0524a544", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "7dad113c-3d5a-4d69-b6ca-c06f8c6160e4", "_parent_code": "sample string 6", "sales_organization_id": "460f48e9-f8ca-45db-9e76-696df0a5c447", "sales_organization_code": "sample string 8", "sales_organization": { "id": "4196993c-373e-432b-bda9-ff08659ae9c0", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "33b28110-c6be-4048-bec5-e83e86149ace", "db_currency_id": "38534b35-94e0-4d40-802e-c64dcac194b7", "db_language_id": "4d163ef6-872e-4df7-96c7-4b41add98a91", "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": "2024-03-27T09:00:29.9521794+00:00" }, "modified_dateutc": "2024-03-27T09:00:29.9521794+00:00" }, "equipment_model_id": "6034bd2e-1a4b-4dd0-99b1-4be11c4eb8c8", "equipment_model_code": "sample string 8", "equipment_model": { "id": "c5205d50-8ba4-44ce-ae2f-ef8d117ef412", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "11875fc8-5504-4faa-80be-26989ae96ebe", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "5bf2e2c7-9434-4766-8806-01c483b65bde", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "4560e3f7-6033-4c04-99e1-fabd45232cf9", "sales_organization_code": "sample string 5", "sales_organization": { "id": "4196993c-373e-432b-bda9-ff08659ae9c0", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "33b28110-c6be-4048-bec5-e83e86149ace", "db_currency_id": "38534b35-94e0-4d40-802e-c64dcac194b7", "db_language_id": "4d163ef6-872e-4df7-96c7-4b41add98a91", "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": "2024-03-27T09:00:29.9521794+00:00" }, "modified_dateutc": "2024-03-27T09:00:29.9521794+00:00" }, "equipment_family_id": "c5df8d33-c22e-47b8-9c61-fb62de05a44b", "equipment_family_code": "sample string 8", "equipment_family": { "id": "8e19fe27-70e4-46fa-ad2f-528c0524a544", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "7dad113c-3d5a-4d69-b6ca-c06f8c6160e4", "_parent_code": "sample string 6", "sales_organization_id": "460f48e9-f8ca-45db-9e76-696df0a5c447", "sales_organization_code": "sample string 8", "sales_organization": { "id": "4196993c-373e-432b-bda9-ff08659ae9c0", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "33b28110-c6be-4048-bec5-e83e86149ace", "db_currency_id": "38534b35-94e0-4d40-802e-c64dcac194b7", "db_language_id": "4d163ef6-872e-4df7-96c7-4b41add98a91", "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": "2024-03-27T09:00:29.9521794+00:00" }, "modified_dateutc": "2024-03-27T09:00:29.9521794+00:00" }, "date_in_production_since": "2024-03-27T09:00:29.9521794+00:00", "date_out_of_production_since": "2024-03-27T09:00:29.9521794+00:00", "date_end_support": "2024-03-27T09:00:29.9521794+00:00", "sales_organization_id": "ec1b5e11-daea-497d-a243-ad3fe6538ea5", "sales_organization_code": "sample string 13", "sales_organization": { "id": "4196993c-373e-432b-bda9-ff08659ae9c0", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "33b28110-c6be-4048-bec5-e83e86149ace", "db_currency_id": "38534b35-94e0-4d40-802e-c64dcac194b7", "db_language_id": "4d163ef6-872e-4df7-96c7-4b41add98a91", "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": "2024-03-27T09:00:29.9521794+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": "2024-03-27T09:00:29.9521794+00:00" }, "project_status_id": "f1a5c749-9e6a-482f-976c-dd2ad5c7a2cf", "project_status_code": "sample string 10", "project_status": { "id": "09508d7a-3852-48e8-b681-8a4c1bbcfb55", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "c89e3e14-36e9-4400-ac7c-0b63eb8a2c81", "sales_organization_code": "sample string 6", "sales_organization": { "id": "4196993c-373e-432b-bda9-ff08659ae9c0", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "33b28110-c6be-4048-bec5-e83e86149ace", "db_currency_id": "38534b35-94e0-4d40-802e-c64dcac194b7", "db_language_id": "4d163ef6-872e-4df7-96c7-4b41add98a91", "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": "2024-03-27T09:00:29.9521794+00:00" }, "code": "sample string 7", "modified_dateutc": "2024-03-27T09:00:29.9521794+00:00" }, "company_id": "49c6e1b1-95f1-4c43-a68e-a09c38976bf1", "company_code": "sample string 12", "db_address_id": "69571657-d69e-4945-8012-9e6a6960f839", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "f1917755-156d-4942-ac09-7ae80c0d4a6d", "contact_reference_back_office": "sample string 17", "owner_user_id": "34da13a5-7813-402a-94a1-814e522bd6a1", "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": "2024-03-27T09:00:29.9521794+00:00", "date_create": "2024-03-27T09:00:29.9521794+00:00", "date_update": "2024-03-27T09:00:29.9521794+00:00", "updated_by_user_id": "557f2211-45c0-400c-bf8b-e0f737e221ae", "customer_reference": "sample string 28", "warranty_date_until": "2024-03-27T09:00:29.9521794+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": "2024-03-27T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2024-03-27T09:00:29.9521794+00:00", "date_last_job": "2024-03-27T09:00:29.9521794+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2024-03-27T09:00:29.9521794+00:00", "modified_dateutc": "2024-03-27T09:00:29.9521794+00:00", "is_mobile_installation": true }, "job_type_id": "1a3d1caf-bbe8-49c0-b69d-c43c7fd0fccf", "job_type_code": "sample string 7", "job_type": { "id": "037667e6-c5c2-4f6d-9831-435913d4b291", "name": "sample string 2", "sales_organization_id": "4c269108-b247-4580-a383-093555509795", "description": "sample string 4", "is_default": true, "modified_dateutc": "2024-03-27T09:00:29.9521794+00:00", "code": "sample string 7" }, "job_priority_id": "6b3c546d-9444-4f30-9e48-6ed995fe2863", "job_priority_code": "sample string 9", "job_priority": { "id": "3144fcd9-d8c7-48c7-aaec-b598640b420e", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "54a5c27f-eef4-45ef-a0f8-2e80cf15178b", "sales_organization_code": "sample string 6", "sales_organization": { "id": "4196993c-373e-432b-bda9-ff08659ae9c0", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "33b28110-c6be-4048-bec5-e83e86149ace", "db_currency_id": "38534b35-94e0-4d40-802e-c64dcac194b7", "db_language_id": "4d163ef6-872e-4df7-96c7-4b41add98a91", "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": "2024-03-27T09:00:29.9521794+00:00" }, "code": "sample string 7", "modified_dateutc": "2024-03-27T09:00:29.9521794+00:00" }, "job_status_id": "2b232219-5b66-47bc-9cc1-724a74d828fe", "job_status_code": "sample string 11", "db_address_id": "c06372f6-4848-4d1d-ab6d-9c7e22913b30", "contact_id": "d387973f-5c8b-43b3-bb40-22820a3eb658", "requested_by_company_id": "1f304bb7-aedb-4a7a-b39a-6a3613f4d2a0", "requested_by_contact_id": "ccc2a3a7-fa46-4d20-a9b0-c90495892e7c", "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": "2024-03-27T09:00:29.9521794+00:00", "due_date": "2024-03-27T09:00:29.9521794+00:00", "date_create": "2024-03-27T09:00:29.9521794+00:00", "date_update": "2024-03-27T09:00:29.9521794+00:00", "date_closed": "2024-03-27T09:00:29.9521794+00:00", "suggested_user_id": "49400eaa-a2b7-4fca-ab95-a1c18822541c", "suggested_user_code": "sample string 29", "suggested_user": { "id": "0948e18c-63e7-46dc-bfa4-be06e2c3d34b", "db_language_id": "8334c7c0-0d51-4728-a999-6b477b9c6dc9", "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": "2024-03-27T09:00:29.9521794+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "baab5ef3-d2d4-4478-adcc-f5173f8841fe", "sales_organization": { "id": "4196993c-373e-432b-bda9-ff08659ae9c0", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "33b28110-c6be-4048-bec5-e83e86149ace", "db_currency_id": "38534b35-94e0-4d40-802e-c64dcac194b7", "db_language_id": "4d163ef6-872e-4df7-96c7-4b41add98a91", "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": "2024-03-27T09:00:29.9521794+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "b34e3a85-a25f-45e5-9cb4-47ae072a362b", "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": "b47aff14-f8fa-42f7-864f-0e37aff4d0e6", "private_db_country_code": "sample string 35", "modified_dateutc": "2024-03-27T09:00:29.9521794+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "975a752d-4936-4ff7-8634-396532482ad6" }, "suggested_date_start": "2024-03-27T09:00:29.9521794+00:00", "skill_id": "b55454b4-19a0-47b8-ae05-967ac13c08a3", "skill_code": "sample string 32", "skill": { "id": "6131d508-bbb8-4552-9c95-78edc55188c1", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "a504a3b9-f4a6-4ed4-9bea-90362dae9d33", "sales_organization_code": "sample string 6", "sales_organization": { "id": "4196993c-373e-432b-bda9-ff08659ae9c0", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "33b28110-c6be-4048-bec5-e83e86149ace", "db_currency_id": "38534b35-94e0-4d40-802e-c64dcac194b7", "db_language_id": "4d163ef6-872e-4df7-96c7-4b41add98a91", "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": "2024-03-27T09:00:29.9521794+00:00" }, "modified_dateutc": "2024-03-27T09:00:29.9521794+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "c3a161be-51b8-4084-8179-865d649ba9c9", "date_reported_by_company": "2024-03-27T09:00:29.9521794+00:00", "id2": 36, "company_id": "34b778fb-afd3-42b1-99f1-f006546476c7", "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": "2760b0ca-c043-4bd6-87bb-6df0ed15c72b", "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": "2024-03-27T09:00:29.9521794+00:00" }
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.