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": "afbed324-be9b-4850-8cf3-da43e9dee1ad", "_parent_id": "e4b2d64d-2fbe-4b73-a078-cc9e64b10c4a", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "adbe9933-d451-44fa-b826-b08c76713b16", "project_reference_back_office": "sample string 5", "project": { "id": "2899b86f-289c-41c5-b164-ef4c857f8bec", "_parent_id": "d2c07b2e-2ef3-4c98-bcb8-dbc4c5a882fe", "root_parent_id": "1f8f24b7-d40a-43af-962a-0b87e4c9bb3a", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "3d4f704a-05cb-40ba-980e-3def2507f5e6", "equipment_family_code": "sample string 6", "equipment_family": { "id": "4159fcb5-7bfb-4ae0-86b1-f2e94fe0daa8", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "649201be-a60d-4ad9-81e9-1d9e40234850", "_parent_code": "sample string 6", "sales_organization_id": "340c9c0d-599b-48e8-b86b-aa6ab421cf70", "sales_organization_code": "sample string 8", "sales_organization": { "id": "764439b8-2aa1-4489-9bb0-60d4f94f6698", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "7c848009-b089-4579-9ab7-c2a9928e21ad", "db_currency_id": "543154dc-3b6c-466e-8f5d-283bb915e5b6", "db_language_id": "daa6e9d6-6f7f-485c-bfc5-aca18cd363a9", "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-19T08:27:49.3170471+00:00" }, "modified_dateutc": "2025-02-19T08:27:49.3170471+00:00" }, "equipment_model_id": "231b07fb-49f0-4972-9621-d5345f6f948b", "equipment_model_code": "sample string 8", "equipment_model": { "id": "f9f4b5e5-dacc-40d2-b7a7-66486e1eeb16", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "997accd7-9fc8-48b9-881c-ff7531cad022", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "140abe43-3f33-41ac-bea4-3a1cae95525d", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "9a03e1ee-9142-4d93-8f6c-a4be274f135b", "sales_organization_code": "sample string 5", "sales_organization": { "id": "764439b8-2aa1-4489-9bb0-60d4f94f6698", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "7c848009-b089-4579-9ab7-c2a9928e21ad", "db_currency_id": "543154dc-3b6c-466e-8f5d-283bb915e5b6", "db_language_id": "daa6e9d6-6f7f-485c-bfc5-aca18cd363a9", "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-19T08:27:49.3170471+00:00" }, "modified_dateutc": "2025-02-19T08:27:49.3170471+00:00" }, "equipment_family_id": "449d1511-9e06-4cef-92d9-33e465d9a57e", "equipment_family_code": "sample string 8", "equipment_family": { "id": "4159fcb5-7bfb-4ae0-86b1-f2e94fe0daa8", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "649201be-a60d-4ad9-81e9-1d9e40234850", "_parent_code": "sample string 6", "sales_organization_id": "340c9c0d-599b-48e8-b86b-aa6ab421cf70", "sales_organization_code": "sample string 8", "sales_organization": { "id": "764439b8-2aa1-4489-9bb0-60d4f94f6698", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "7c848009-b089-4579-9ab7-c2a9928e21ad", "db_currency_id": "543154dc-3b6c-466e-8f5d-283bb915e5b6", "db_language_id": "daa6e9d6-6f7f-485c-bfc5-aca18cd363a9", "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-19T08:27:49.3170471+00:00" }, "modified_dateutc": "2025-02-19T08:27:49.3170471+00:00" }, "date_in_production_since": "2025-02-19T08:27:49.3170471+00:00", "date_out_of_production_since": "2025-02-19T08:27:49.3170471+00:00", "date_end_support": "2025-02-19T08:27:49.3170471+00:00", "sales_organization_id": "1058651c-3c27-4e24-90cb-0706e32f4376", "sales_organization_code": "sample string 13", "sales_organization": { "id": "764439b8-2aa1-4489-9bb0-60d4f94f6698", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "7c848009-b089-4579-9ab7-c2a9928e21ad", "db_currency_id": "543154dc-3b6c-466e-8f5d-283bb915e5b6", "db_language_id": "daa6e9d6-6f7f-485c-bfc5-aca18cd363a9", "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-19T08:27:49.3170471+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-19T08:27:49.3170471+00:00" }, "project_status_id": "49b43617-36ec-49fc-9ffa-1b1a661e6a67", "project_status_code": "sample string 10", "project_status": { "id": "f5646206-f89e-45db-b656-49569c1cf291", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "34ca16e4-f7f7-4cdc-a1d0-163dad629ad7", "sales_organization_code": "sample string 6", "sales_organization": { "id": "764439b8-2aa1-4489-9bb0-60d4f94f6698", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "7c848009-b089-4579-9ab7-c2a9928e21ad", "db_currency_id": "543154dc-3b6c-466e-8f5d-283bb915e5b6", "db_language_id": "daa6e9d6-6f7f-485c-bfc5-aca18cd363a9", "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-19T08:27:49.3170471+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-02-19T08:27:49.3170471+00:00" }, "company_id": "190d722d-45d4-4a32-9651-db830cb18937", "company_code": "sample string 12", "db_address_id": "af5a3ab1-39dc-4d11-ac0b-7ffaac454c46", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "3b117f7e-348f-4b8b-80ad-f70ac7984ac1", "contact_reference_back_office": "sample string 17", "owner_user_id": "bbc37e2f-89b5-47be-b03b-f1227c1c3843", "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-19T08:27:49.3170471+00:00", "date_create": "2025-02-19T08:27:49.3170471+00:00", "date_update": "2025-02-19T08:27:49.3170471+00:00", "updated_by_user_id": "d06f7755-750c-4b9f-a65d-4b6c059a3051", "customer_reference": "sample string 28", "warranty_date_until": "2025-02-19T08:27:49.3170471+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-19T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-02-19T08:27:49.3170471+00:00", "date_last_job": "2025-02-19T08:27:49.3170471+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-02-19T08:27:49.3170471+00:00", "modified_dateutc": "2025-02-19T08:27:49.3170471+00:00", "is_mobile_installation": true }, "job_type_id": "28c4aeff-ac6a-41e3-a0e0-71db4c5a932b", "job_type_code": "sample string 7", "job_type": { "id": "8d486d87-2a12-42e7-a69f-a19af58a87b0", "name": "sample string 2", "sales_organization_id": "cf30da5c-e7e5-4606-bf24-bfb5e31ae815", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-02-19T08:27:49.3170471+00:00", "code": "sample string 7" }, "job_priority_id": "67da24c7-d67b-4ab5-9251-4d8f8b0d680f", "job_priority_code": "sample string 9", "job_priority": { "id": "fb719eb1-a2d1-4e2c-9715-c8fa7bf87eea", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "99870786-4370-45b2-95f6-f140735e17b9", "sales_organization_code": "sample string 6", "sales_organization": { "id": "764439b8-2aa1-4489-9bb0-60d4f94f6698", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "7c848009-b089-4579-9ab7-c2a9928e21ad", "db_currency_id": "543154dc-3b6c-466e-8f5d-283bb915e5b6", "db_language_id": "daa6e9d6-6f7f-485c-bfc5-aca18cd363a9", "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-19T08:27:49.3170471+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-02-19T08:27:49.3170471+00:00" }, "job_status_id": "d530de56-40a2-4ac0-aee1-e49890741700", "job_status_code": "sample string 11", "db_address_id": "9a5eb47d-23ab-4b8e-b817-8ffd3e50d82b", "contact_id": "731b5112-21c1-418c-bbd3-20bfe8163d9a", "requested_by_company_id": "f423e4bc-3ccf-4b79-8e33-e6dfbef1c96b", "requested_by_contact_id": "ea461b5f-80da-49db-8e27-f5fbd15d3ec9", "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-19T08:27:49.332673+00:00", "due_date": "2025-02-19T08:27:49.332673+00:00", "date_create": "2025-02-19T08:27:49.332673+00:00", "date_update": "2025-02-19T08:27:49.332673+00:00", "date_closed": "2025-02-19T08:27:49.332673+00:00", "suggested_user_id": "02eeecac-0fa5-4489-b551-b1dc14853ec2", "suggested_user_code": "sample string 29", "suggested_user": { "id": "5f4c5f18-e20c-4233-9b4d-4fad6408a9b2", "db_language_id": "154bde8a-5af6-49d0-8f15-0d86e2a2904c", "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-19T08:27:49.332673+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "e557b1ff-f7e0-41ba-9d45-819f7c9ed74b", "sales_organization": { "id": "764439b8-2aa1-4489-9bb0-60d4f94f6698", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "7c848009-b089-4579-9ab7-c2a9928e21ad", "db_currency_id": "543154dc-3b6c-466e-8f5d-283bb915e5b6", "db_language_id": "daa6e9d6-6f7f-485c-bfc5-aca18cd363a9", "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-19T08:27:49.3170471+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "2fb7a40d-1372-43aa-8224-b4cb242325e1", "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": "df17b513-a675-4f43-942f-ed80da9d354b", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-02-19T08:27:49.332673+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "36fb2b1f-f00e-40af-bda4-68bb64fbac53" }, "suggested_date_start": "2025-02-19T08:27:49.332673+00:00", "skill_id": "4fd5bebf-203e-4666-8b36-dc759db7150f", "skill_code": "sample string 32", "skill": { "id": "9929da7c-6bec-4030-bafb-46ff58af74df", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "329c3ffb-bb28-4345-bfbf-a9f12e46a1de", "sales_organization_code": "sample string 6", "sales_organization": { "id": "764439b8-2aa1-4489-9bb0-60d4f94f6698", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "7c848009-b089-4579-9ab7-c2a9928e21ad", "db_currency_id": "543154dc-3b6c-466e-8f5d-283bb915e5b6", "db_language_id": "daa6e9d6-6f7f-485c-bfc5-aca18cd363a9", "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-19T08:27:49.3170471+00:00" }, "modified_dateutc": "2025-02-19T08:27:49.332673+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "a8b6e371-b90a-442b-a38f-1bc74f384ae6", "date_reported_by_company": "2025-02-19T08:27:49.332673+00:00", "id2": 36, "company_id": "1300c286-1efb-4d7e-95cd-c5a27ab262f2", "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": "dd87d318-d799-4933-bc14-3ac7cd67784c", "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-19T08:27:49.332673+00:00" }
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.