Create a geofence
post
/hcmRestApi/resources/11.13.18.05/timeGeofences
Request
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
Code: string
Maximum Length:
256
Nontranslatable code for the geofence name. For example, if the name is Pleasanton Building 1, the code is PLEASANTON BUILDING 1. -
Description: string
Maximum Length:
4000
Description for a geofence. -
GeofenceId: integer
(int64)
Unique identifier for the geofence.
-
GeoJson: string
GeoJson coordinates for a geofence.
-
LocationId: integer
(int64)
Unique identifier for the work location.
-
Name: string
Maximum Length:
256
Name of the geofence. -
Radius: integer
(int32)
Allowed radius for the geofence.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : timeGeofences-item-response
Type:
Show Source
object
-
Code: string
Maximum Length:
256
Nontranslatable code for the geofence name. For example, if the name is Pleasanton Building 1, the code is PLEASANTON BUILDING 1. -
Description: string
Maximum Length:
4000
Description for a geofence. -
GeofenceId: integer
(int64)
Unique identifier for the geofence.
-
GeoJson: string
GeoJson coordinates for a geofence.
-
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the geofence was most recently updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Person who most recently updated the geofence. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationId: integer
(int64)
Unique identifier for the work location.
-
LocationName: string
Read Only:
true
Maximum Length:255
Name of the location the geofence is defined for. -
LocationValidFlag: boolean
Read Only:
true
Indicates whether the location is valid. -
Name: string
Maximum Length:
256
Name of the geofence. -
Radius: integer
(int32)
Allowed radius for the geofence.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.