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": "a3bf1aea-d96f-437b-8c4d-4387fd750732", "_parent_id": "5df9561e-a6aa-48c3-a24b-73b1c8afa2bf", "_parent_jobs_reference_back_office": "sample string 3", "project_id": "e3fa686b-21d3-45e3-a905-7e3a2c87f863", "project_reference_back_office": "sample string 5", "project": { "id": "d03d322d-ba70-4ac7-bfdd-be62aaf08279", "_parent_id": "23d276cf-ed53-4a07-9790-ebb843880047", "root_parent_id": "e6c7eae0-4844-497c-892e-4a65969aa4d0", "_parent_reference_back_office": "sample string 4", "equipment_family_id": "700b2d7d-41a4-45dc-b1dc-ace9ea4e62b1", "equipment_family_code": "sample string 6", "equipment_family": { "id": "f1c87dcd-2bb6-407e-9239-36e665a65ad5", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "ceb8e79f-a757-449c-97c0-f7ba076a8fbf", "_parent_code": "sample string 6", "sales_organization_id": "7dd8ead2-f30f-40e9-abb0-063142b13e78", "sales_organization_code": "sample string 8", "sales_organization": { "id": "0a3a5ffa-3a2a-4314-aa7b-96a29634d66e", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "0d2249c7-3e7f-4b45-b50a-d2c9147b7862", "db_currency_id": "7de9b9e7-59fc-4eef-8fd1-9d696c3da451", "db_language_id": "398d2788-9557-4328-8d61-1b32f115c591", "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-04-22T04:54:52.3856868+00:00" }, "modified_dateutc": "2024-04-22T04:54:52.3856868+00:00" }, "equipment_model_id": "f5506464-a7d8-4526-a02f-550e430cb9d5", "equipment_model_code": "sample string 8", "equipment_model": { "id": "41fc3bb0-283f-446b-9793-67987b066c96", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "equipment_brand_id": "7f94fe6f-1bbb-45a7-a4c2-ca12d4d4ea30", "equipment_brand_code": "sample string 6", "equipment_brand": { "id": "312bc00c-4d37-4f25-859e-bb1ae79614cf", "name": "sample string 2", "code": "sample string 3", "sales_organization_id": "7192c150-c6ec-42d9-bb6f-35a579e9025b", "sales_organization_code": "sample string 5", "sales_organization": { "id": "0a3a5ffa-3a2a-4314-aa7b-96a29634d66e", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "0d2249c7-3e7f-4b45-b50a-d2c9147b7862", "db_currency_id": "7de9b9e7-59fc-4eef-8fd1-9d696c3da451", "db_language_id": "398d2788-9557-4328-8d61-1b32f115c591", "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-04-22T04:54:52.3856868+00:00" }, "modified_dateutc": "2024-04-22T04:54:52.4013122+00:00" }, "equipment_family_id": "43c92276-37b3-45e1-aa07-34a734bcf99f", "equipment_family_code": "sample string 8", "equipment_family": { "id": "f1c87dcd-2bb6-407e-9239-36e665a65ad5", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "_parent_id": "ceb8e79f-a757-449c-97c0-f7ba076a8fbf", "_parent_code": "sample string 6", "sales_organization_id": "7dd8ead2-f30f-40e9-abb0-063142b13e78", "sales_organization_code": "sample string 8", "sales_organization": { "id": "0a3a5ffa-3a2a-4314-aa7b-96a29634d66e", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "0d2249c7-3e7f-4b45-b50a-d2c9147b7862", "db_currency_id": "7de9b9e7-59fc-4eef-8fd1-9d696c3da451", "db_language_id": "398d2788-9557-4328-8d61-1b32f115c591", "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-04-22T04:54:52.3856868+00:00" }, "modified_dateutc": "2024-04-22T04:54:52.3856868+00:00" }, "date_in_production_since": "2024-04-22T04:54:52.4013122+00:00", "date_out_of_production_since": "2024-04-22T04:54:52.4013122+00:00", "date_end_support": "2024-04-22T04:54:52.4013122+00:00", "sales_organization_id": "f841d769-aaff-420e-a300-5ef4c443284b", "sales_organization_code": "sample string 13", "sales_organization": { "id": "0a3a5ffa-3a2a-4314-aa7b-96a29634d66e", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "0d2249c7-3e7f-4b45-b50a-d2c9147b7862", "db_currency_id": "7de9b9e7-59fc-4eef-8fd1-9d696c3da451", "db_language_id": "398d2788-9557-4328-8d61-1b32f115c591", "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-04-22T04:54:52.3856868+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-04-22T04:54:52.4013122+00:00" }, "project_status_id": "007e0942-9b13-46c3-b6b6-07e652de88e4", "project_status_code": "sample string 10", "project_status": { "id": "a5ae593e-f67e-496e-8cc3-49d03ba7ce2e", "name": "sample string 2", "is_default": true, "is_closed": true, "sales_organization_id": "f067db75-466c-4e49-b73d-2f3983931ccc", "sales_organization_code": "sample string 6", "sales_organization": { "id": "0a3a5ffa-3a2a-4314-aa7b-96a29634d66e", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "0d2249c7-3e7f-4b45-b50a-d2c9147b7862", "db_currency_id": "7de9b9e7-59fc-4eef-8fd1-9d696c3da451", "db_language_id": "398d2788-9557-4328-8d61-1b32f115c591", "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-04-22T04:54:52.3856868+00:00" }, "code": "sample string 7", "modified_dateutc": "2024-04-22T04:54:52.4013122+00:00" }, "company_id": "06f903f0-8aa0-4e5c-9689-b6443b8d03b8", "company_code": "sample string 12", "db_address_id": "c42c9f43-5df9-4a6d-b31d-14dbed2a12a2", "db_address_code": "sample string 14", "location": "sample string 15", "contact_id": "57349d7b-370d-4a30-8ca5-fd816ed60f3b", "contact_reference_back_office": "sample string 17", "owner_user_id": "9d94edaf-126f-4aa9-a884-1709bab1a04a", "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-04-22T04:54:52.4013122+00:00", "date_create": "2024-04-22T04:54:52.4013122+00:00", "date_update": "2024-04-22T04:54:52.4013122+00:00", "updated_by_user_id": "4e6a5a16-ceff-4e8c-9ea4-128b32c6523f", "customer_reference": "sample string 28", "warranty_date_until": "2024-04-22T04:54:52.4013122+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-04-22T00:00:00+00:00", "shutdown_consequence": "sample string 35", "id2": 36, "nb_open_jobs": 37, "date_next_job": "2024-04-22T04:54:52.4013122+00:00", "date_last_job": "2024-04-22T04:54:52.4013122+00:00", "nb_jobs_planned": 40, "nb_jobs_tobeplanned": 41, "nb_jobs_waitingfurtheraction": 42, "back_office_timestamp": "2024-04-22T04:54:52.4013122+00:00", "modified_dateutc": "2024-04-22T04:54:52.4013122+00:00", "is_mobile_installation": true }, "job_type_id": "45a9f349-a934-48a9-85fb-a204273a8fb7", "job_type_code": "sample string 7", "job_type": { "id": "e9890c2f-69d4-4802-8953-b8e95f38732a", "name": "sample string 2", "sales_organization_id": "1b22722a-8813-4aed-8415-79b4f397d74c", "description": "sample string 4", "is_default": true, "modified_dateutc": "2024-04-22T04:54:52.4013122+00:00", "code": "sample string 7" }, "job_priority_id": "f2a7c9e8-4b38-440b-b636-7c9193b669bf", "job_priority_code": "sample string 9", "job_priority": { "id": "aad86c1f-fe3a-4375-b833-183cc8410eb0", "name": "sample string 2", "is_default": true, "sequence": 4, "sales_organization_id": "f50c66f6-90cd-426b-b257-4f492c05881d", "sales_organization_code": "sample string 6", "sales_organization": { "id": "0a3a5ffa-3a2a-4314-aa7b-96a29634d66e", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "0d2249c7-3e7f-4b45-b50a-d2c9147b7862", "db_currency_id": "7de9b9e7-59fc-4eef-8fd1-9d696c3da451", "db_language_id": "398d2788-9557-4328-8d61-1b32f115c591", "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-04-22T04:54:52.3856868+00:00" }, "code": "sample string 7", "modified_dateutc": "2024-04-22T04:54:52.4013122+00:00" }, "job_status_id": "869a465e-d83d-4ecc-855c-4f24ad8a455a", "job_status_code": "sample string 11", "db_address_id": "3472a715-215a-4492-ac87-1bf1b80212a7", "contact_id": "2943844c-5f52-4a9f-9af8-2e6bf549d8fa", "requested_by_company_id": "a87bb2bc-5918-48fd-be1d-483bc7ed1650", "requested_by_contact_id": "a68535b9-deee-4362-8f64-5494bb0c0f56", "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-04-22T04:54:52.4013122+00:00", "due_date": "2024-04-22T04:54:52.4013122+00:00", "date_create": "2024-04-22T04:54:52.4013122+00:00", "date_update": "2024-04-22T04:54:52.4013122+00:00", "date_closed": "2024-04-22T04:54:52.4013122+00:00", "suggested_user_id": "e62e45bd-40e0-496a-a20b-242b39a88d0d", "suggested_user_code": "sample string 29", "suggested_user": { "id": "26a4e71b-d0eb-4d96-a176-3d57f9c91757", "db_language_id": "cd014641-c57f-4463-bea3-3d5a2a4c3591", "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-04-22T04:54:52.4013122+00:00", "skype": "sample string 16", "notes": "sample string 17", "sales_organization_id": "c4c8edec-3351-498d-8fce-7ceecfcef869", "sales_organization": { "id": "0a3a5ffa-3a2a-4314-aa7b-96a29634d66e", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "0d2249c7-3e7f-4b45-b50a-d2c9147b7862", "db_currency_id": "7de9b9e7-59fc-4eef-8fd1-9d696c3da451", "db_language_id": "398d2788-9557-4328-8d61-1b32f115c591", "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-04-22T04:54:52.3856868+00:00" }, "sales_organization_code": "sample string 19", "is_team_leader": true, "team_leader_user_id": "f120838d-a87a-42a4-857c-ab88ecb71a43", "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": "bbdb812a-3a9d-4898-bbe4-15d2284a2b21", "private_db_country_code": "sample string 35", "modified_dateutc": "2024-04-22T04:54:52.4013122+00:00", "allow_hero_app": true, "allow_sales_app": true, "allow_service_app": true, "user_group_id": "4bedf654-468d-426d-9a5c-41c8002bdfa1" }, "suggested_date_start": "2024-04-22T04:54:52.4013122+00:00", "skill_id": "7d44ba20-04fe-4580-8f92-214228b50630", "skill_code": "sample string 32", "skill": { "id": "3c672695-fe02-40b2-9fef-c54da74707cf", "name": "sample string 2", "description": "sample string 3", "code": "sample string 4", "sales_organization_id": "8ee1834b-0c7f-4b0f-a3b8-2702e66041bb", "sales_organization_code": "sample string 6", "sales_organization": { "id": "0a3a5ffa-3a2a-4314-aa7b-96a29634d66e", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "0d2249c7-3e7f-4b45-b50a-d2c9147b7862", "db_currency_id": "7de9b9e7-59fc-4eef-8fd1-9d696c3da451", "db_language_id": "398d2788-9557-4328-8d61-1b32f115c591", "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-04-22T04:54:52.3856868+00:00" }, "modified_dateutc": "2024-04-22T04:54:52.4013122+00:00" }, "customer_reference": "sample string 33", "approval_responsible_user_id": "dea07b3c-9a54-452a-adc5-9f0179d88022", "date_reported_by_company": "2024-04-22T04:54:52.4013122+00:00", "id2": 36, "company_id": "306adbfc-1d1e-47af-809c-b9e2db264144", "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": "e7c0d0e4-7dbd-42d0-86e1-c5e3ca9ba79d", "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-04-22T04:54:52.4013122+00:00" }
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample not available.