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": "7acceee1-d80c-426c-a9ff-1ed6d9406f0f", "_parent_id": "0ab08143-fe35-48be-a17b-5acd79ed21e3", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "8f13e8f4-ae71-4f8b-b740-096f781ba3a2", "project_reference_back_office": "sample string 5", "project": { "id": "deadbf1b-f8da-4e74-9f80-2703336b71ce", "_parent_id": "d37915ef-7379-4f8c-b33d-a2508e26c3e8", "root_parent_id": "2254c1d2-484b-4cf8-8a75-613906b8a8e7", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "7107ee0b-ac6d-4e3f-9e9d-1111bddefe29", "equipment_family_code": "sample string 6", "equipment_family": { "id": "d6ce2212-60d4-4cac-8418-876996a41a14", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "d732a423-da4a-4ef5-b617-2789fd875098", "_parent_code": "sample string 6", "sales_organization_id": "b9903ebb-2be2-4029-9b3a-95a8922a177b", "sales_organization_code": "sample string 8", "sales_organization": { "id": "c71dc05e-d1ab-4d66-8584-096b24b9e90a", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "73d3fb0d-c8e9-4399-9848-6809cb8820ce", "db_currency_id": "22f6cfb2-f8bf-4013-84b0-3506b44c65f2", "db_language_id": "5edc0865-458d-42b5-a1f9-6364e2ddb94e", "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-05-09T01:38:02.6706431+00:00" }, "modified_dateutc": "2025-05-09T01:38:02.6706431+00:00" }, "equipment_model_id": "0c47c292-8162-498c-9e04-19a1d00a5e8a", "equipment_model_code": "sample string 8", "equipment_model": { "id": "4b9d87d0-646d-4040-b118-cee01fa7f9a5", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "1c0cbd72-d2f0-4dfa-b325-86e3d1f91e2c", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "1ad67dce-670f-471d-8e17-fc36c6074d7d", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "4421f439-32c1-4064-a1e9-00ce19bd0ffc", "sales_organization_code": "sample string 5", "sales_organization": { "id": "c71dc05e-d1ab-4d66-8584-096b24b9e90a", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "73d3fb0d-c8e9-4399-9848-6809cb8820ce", "db_currency_id": "22f6cfb2-f8bf-4013-84b0-3506b44c65f2", "db_language_id": "5edc0865-458d-42b5-a1f9-6364e2ddb94e", "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-05-09T01:38:02.6706431+00:00" }, "modified_dateutc": "2025-05-09T01:38:02.6706431+00:00" }, "equipment_family_id": "4c5120c1-6528-44ab-9668-069848d1e9ee", "equipment_family_code": "sample string 8", "equipment_family": { "id": "d6ce2212-60d4-4cac-8418-876996a41a14", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "d732a423-da4a-4ef5-b617-2789fd875098", "_parent_code": "sample string 6", "sales_organization_id": "b9903ebb-2be2-4029-9b3a-95a8922a177b", "sales_organization_code": "sample string 8", "sales_organization": { "id": "c71dc05e-d1ab-4d66-8584-096b24b9e90a", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "73d3fb0d-c8e9-4399-9848-6809cb8820ce", "db_currency_id": "22f6cfb2-f8bf-4013-84b0-3506b44c65f2", "db_language_id": "5edc0865-458d-42b5-a1f9-6364e2ddb94e", "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-05-09T01:38:02.6706431+00:00" }, "modified_dateutc": "2025-05-09T01:38:02.6706431+00:00" }, "date_in_production_since": "2025-05-09T01:38:02.6706431+00:00", "date_out_of_production_since": "2025-05-09T01:38:02.6706431+00:00", "date_end_support": "2025-05-09T01:38:02.6706431+00:00", "sales_organization_id": "27eca54c-4540-4f67-a0c4-9084ca6dfbdd", "sales_organization_code": "sample string 13", "sales_organization": { "id": "c71dc05e-d1ab-4d66-8584-096b24b9e90a", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "73d3fb0d-c8e9-4399-9848-6809cb8820ce", "db_currency_id": "22f6cfb2-f8bf-4013-84b0-3506b44c65f2", "db_language_id": "5edc0865-458d-42b5-a1f9-6364e2ddb94e", "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-05-09T01:38:02.6706431+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-05-09T01:38:02.6706431+00:00" }, "project_status_id": "16435a64-6262-4a69-a18a-8c0eaf818f18", "project_status_code": "sample string 10", "project_status": { "id": "2f5111f2-0d09-487d-bf55-fd139b8bdffc", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "6ae4179f-7ae1-4e94-a7e4-34e011633506", "sales_organization_code": "sample string 6", "sales_organization": { "id": "c71dc05e-d1ab-4d66-8584-096b24b9e90a", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "73d3fb0d-c8e9-4399-9848-6809cb8820ce", "db_currency_id": "22f6cfb2-f8bf-4013-84b0-3506b44c65f2", "db_language_id": "5edc0865-458d-42b5-a1f9-6364e2ddb94e", "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-05-09T01:38:02.6706431+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-05-09T01:38:02.6706431+00:00" }, "company_id": "61bd8bf2-9d1e-4c69-978e-589310def849", "company_code": "sample string 12", "db_address_id": "3815997e-a997-4184-a7f8-2c188d6f550c", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "f7b74eef-9ca5-44ab-87b0-a46348482222", "contact_reference_back_office": "sample string 17", "owner_user_id": "b35b5d52-770a-44d1-b953-2e64082dda48", "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-05-09T01:38:02.6706431+00:00", "date_create": "2025-05-09T01:38:02.6706431+00:00", "date_update": "2025-05-09T01:38:02.6706431+00:00", "updated_by_user_id": "83d01656-4ece-41ff-b31a-64f4e363b614", "customer_reference": "sample string 28", "warranty_date_until": "2025-05-09T01:38:02.6706431+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-05-09T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2025-05-09T01:38:02.6706431+00:00", "date_last_job": "2025-05-09T01:38:02.6706431+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2025-05-09T01:38:02.6706431+00:00", "modified_dateutc": "2025-05-09T01:38:02.6706431+00:00", "is_mobile_installation": true }, "job_type_id": "9ad9e9f9-1208-43a9-8013-5ec8305302e3", "job_type_code": "sample string 7", "job_type": { "id": "d52a6097-a838-40be-a860-53f50ee56924", "name": "sample string 2", "sales_organization_id": "d91851b7-b184-47d4-a5e2-57e8b998da28", "description": "sample string 4", "is_default": true, "modified_dateutc": "2025-05-09T01:38:02.6706431+00:00", "code": "sample string 7" }, "job_priority_id": "15169cfc-6931-4176-a6ae-7751d6cf09c6", "job_priority_code": "sample string 9", "job_priority": { "id": "b109e649-4c5d-4d28-9ee6-2d1d92188aaa", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "9e736ac5-e60b-4d60-8ff7-b5140b1621ce", "sales_organization_code": "sample string 6", "sales_organization": { "id": "c71dc05e-d1ab-4d66-8584-096b24b9e90a", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "73d3fb0d-c8e9-4399-9848-6809cb8820ce", "db_currency_id": "22f6cfb2-f8bf-4013-84b0-3506b44c65f2", "db_language_id": "5edc0865-458d-42b5-a1f9-6364e2ddb94e", "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-05-09T01:38:02.6706431+00:00" }, "code": "sample string 7", "modified_dateutc": "2025-05-09T01:38:02.6706431+00:00" }, "job_status_id": "71db18a6-a47c-41d2-b2fd-9262bf951f81", "job_status_code": "sample string 11", "db_address_id": "f1bd0cfe-0ac5-4edf-af8c-e14735ccbc1f", "contact_id": "e3b94b86-9e81-4dee-a376-c919c8df5e11", "requested_by_company_id": "2ef5fcd8-c812-4573-963c-2be234889091", "requested_by_contact_id": "2dbda0c9-8b8a-43c7-a5bd-396ba29ea30d", "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-05-09T01:38:02.6706431+00:00", "due_date": "2025-05-09T01:38:02.6706431+00:00", "date_create": "2025-05-09T01:38:02.6706431+00:00", "date_update": "2025-05-09T01:38:02.6706431+00:00", "date_closed": "2025-05-09T01:38:02.6706431+00:00", "suggested_user_id": "528d26dd-b40d-45e5-9563-eca282f86a3c", "suggested_user_code": "sample string 29", "suggested_user": { "id": "48b715a8-9ff9-4ad9-9507-022392174adc", "db_language_id": "81fd8461-497f-4dba-8b64-cfb20eec86cd", "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-05-09T01:38:02.6706431+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "eb3f4fa7-06d0-4ae7-a6a9-e04de75268db", "sales_organization": { "id": "c71dc05e-d1ab-4d66-8584-096b24b9e90a", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "73d3fb0d-c8e9-4399-9848-6809cb8820ce", "db_currency_id": "22f6cfb2-f8bf-4013-84b0-3506b44c65f2", "db_language_id": "5edc0865-458d-42b5-a1f9-6364e2ddb94e", "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-05-09T01:38:02.6706431+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "9c39f767-1276-4770-b19d-b4d8f3b2c881", "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": "8e38476f-d960-4069-8c96-7065e392efd7", "private_db_country_code": "sample string 35", "modified_dateutc": "2025-05-09T01:38:02.6706431+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "6b9d720d-aff4-4ca8-84c5-2b2e8f08bd86" }, "suggested_date_start": "2025-05-09T01:38:02.6706431+00:00", "skill_id": "ab875825-c1a9-4159-ba0d-cacdf1a14d3a", "skill_code": "sample string 32", "skill": { "id": "d2e8d63d-7465-4ae5-a6a7-34f0e6d83390", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "733fe5c8-bd3d-4897-97bc-25d467d7bd45", "sales_organization_code": "sample string 6", "sales_organization": { "id": "c71dc05e-d1ab-4d66-8584-096b24b9e90a", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "73d3fb0d-c8e9-4399-9848-6809cb8820ce", "db_currency_id": "22f6cfb2-f8bf-4013-84b0-3506b44c65f2", "db_language_id": "5edc0865-458d-42b5-a1f9-6364e2ddb94e", "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-05-09T01:38:02.6706431+00:00" }, "modified_dateutc": "2025-05-09T01:38:02.6706431+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "275e9c51-6598-4705-bf0b-40506559766e", "date_reported_by_company": "2025-05-09T01:38:02.6706431+00:00", "id2": 36, "company_id": "e267fb18-a0f3-4795-bfb9-6e0108698c36", "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": "de2e3726-758e-4d06-a8b1-f4e1601fbb3f", "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-05-09T01:38:02.6706431+00:00" }
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.