Create a dashboard configuration
post
/fscmRestApi/resources/11.13.18.05/publicSectorAnalyticsConfigurations
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
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The unique identifier for the agency associated with the dashboard configuration. -
AnalyticsCode: string
Title:
Dashboard ID
Maximum Length:32
The unique identifier for the analytics dashboard configuration. -
AnalyticsDescription: string
Title:
Description
Maximum Length:256
Description of the analytics dashboard. -
AnalyticsPath: string
Title:
Path
Maximum Length:1000
The path of the analytics dashboard. -
DefaultFlag: string
Title:
Default
Maximum Length:1
Identifies the default analytics dashboard. The default value is false. -
EnabledFlag: boolean
Title:
Enabled
Maximum Length:1
Indicates whether the dashboard is available to be used. The default value is false. -
ObjectVersionNumber: integer
(int32)
Used to implement optimistic locking. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
-
SortOrder: integer
(int32)
Title:
Sort Order
The sorting order of the analytics dashboard.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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 : publicSectorAnalyticsConfigurations-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The unique identifier for the agency associated with the dashboard configuration. -
AnalyticsCode: string
Title:
Dashboard ID
Maximum Length:32
The unique identifier for the analytics dashboard configuration. -
AnalyticsDescription: string
Title:
Description
Maximum Length:256
Description of the analytics dashboard. -
AnalyticsPath: string
Title:
Path
Maximum Length:1000
The path of the analytics dashboard. -
AnalyticsType: string
Title:
Type
Read Only:true
Maximum Length:20
Default Value:Dashboard
The type of analytics dashboard. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the dashboard. -
CreationDate: string
(date-time)
Read Only:
true
The date and time that the dashboard was created. -
DefaultFlag: string
Title:
Default
Maximum Length:1
Identifies the default analytics dashboard. The default value is false. -
EnabledFlag: boolean
Title:
Enabled
Maximum Length:1
Indicates whether the dashboard is available to be used. The default value is false. -
LastUpdateDate: string
(date-time)
Read Only:
true
The last date and time that the dashboard was updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the dashboard. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login ID of the user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Used to implement optimistic locking. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
-
SortOrder: integer
(int32)
Title:
Sort Order
The sorting order of the analytics dashboard.
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.