Update a dashboard configuration
patch
/fscmRestApi/resources/11.13.18.05/publicSectorAnalyticsConfigurations/{publicSectorAnalyticsConfigurationsUniqID}
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Path Parameters
-
publicSectorAnalyticsConfigurationsUniqID: integer
This is the hash key of the attributes which make up the composite key--- AnalyticsCode and AgencyId ---for the Dashboard Configurations resource and used to uniquely identify an instance of Dashboard Configurations. The client should not generate the hash key value. Instead, the client should query on the Dashboard Configurations collection resource with a filter on the primary key values in order to navigate to a specific instance of Dashboard Configurations.
For example: publicSectorAnalyticsConfigurations?q=AnalyticsCode=<value1>;AgencyId=<value2>
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorAnalyticsConfigurations-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
The unique identifier for the agency associated with the dashboard configuration.
-
AnalyticsCode(optional):
string
Maximum Length:
32
The unique identifier for the analytics dashboard configuration. -
AnalyticsDescription(optional):
string
Maximum Length:
256
Description of the analytics dashboard. -
AnalyticsPath(optional):
string
Maximum Length:
1000
The path of the analytics dashboard. -
AnalyticsType(optional):
string
Maximum Length:
20
The type of analytics dashboard. -
CreatedBy(optional):
string
Maximum Length:
64
The user who created the dashboard. -
CreationDate(optional):
string(date-time)
The date and time that the dashboard was created.
-
DefaultFlag(optional):
string
Maximum Length:
1
Identifies the default analytics dashboard. The default value is false. -
EnabledFlag(optional):
boolean
Indicates whether the dashboard is available to be used. The default value is false.
-
LastUpdateDate(optional):
string(date-time)
The last date and time that the dashboard was updated.
-
LastUpdatedBy(optional):
string
Maximum Length:
64
The user who last updated the dashboard. -
LastUpdateLogin(optional):
string
Maximum Length:
32
The login ID of the user who last updated the row. -
links(optional):
array Items
Title:
Items
Link Relations -
ObjectVersionNumber(optional):
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(optional):
integer(int32)
The sorting order of the analytics dashboard.
Nested Schema : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorAnalyticsConfigurations-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
The unique identifier for the agency associated with the dashboard configuration.
-
AnalyticsCode(optional):
string
Maximum Length:
32
The unique identifier for the analytics dashboard configuration. -
AnalyticsDescription(optional):
string
Maximum Length:
256
Description of the analytics dashboard. -
AnalyticsPath(optional):
string
Maximum Length:
1000
The path of the analytics dashboard. -
AnalyticsType(optional):
string
Maximum Length:
20
The type of analytics dashboard. -
CreatedBy(optional):
string
Maximum Length:
64
The user who created the dashboard. -
CreationDate(optional):
string(date-time)
The date and time that the dashboard was created.
-
DefaultFlag(optional):
string
Maximum Length:
1
Identifies the default analytics dashboard. The default value is false. -
EnabledFlag(optional):
boolean
Indicates whether the dashboard is available to be used. The default value is false.
-
LastUpdateDate(optional):
string(date-time)
The last date and time that the dashboard was updated.
-
LastUpdatedBy(optional):
string
Maximum Length:
64
The user who last updated the dashboard. -
LastUpdateLogin(optional):
string
Maximum Length:
32
The login ID of the user who last updated the row. -
links(optional):
array Items
Title:
Items
Link Relations -
ObjectVersionNumber(optional):
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(optional):
integer(int32)
The sorting order of the analytics dashboard.
Nested Schema : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.