Jump to

• Request
• Response

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>

Body ()

The following table describes the body parameters in the request for this task.

Root Schema : publicSectorAnalyticsConfigurations-item

Type: object

Show Source

• 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.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier for the agency associated with the dashboard configuration."
        },
        "AnalyticsCode":{
            "maxLength":32,
            "type":"string",
            "description":"The unique identifier for the analytics dashboard configuration."
        },
        "AnalyticsDescription":{
            "maxLength":256,
            "type":"string",
            "description":"Description of the analytics dashboard."
        },
        "AnalyticsPath":{
            "maxLength":1000,
            "type":"string",
            "description":"The path of the analytics dashboard."
        },
        "AnalyticsType":{
            "maxLength":20,
            "type":"string",
            "description":"The type of analytics dashboard."
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the dashboard."
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time that the dashboard was created."
        },
        "DefaultFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Identifies the default analytics dashboard. The default value is false."
        },
        "EnabledFlag":{
            "type":"boolean",
            "description":"Indicates whether the dashboard is available to be used. The default value is false."
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The last date and time that the dashboard was updated."
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login ID of the user who last updated the row."
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the dashboard."
        },
        "ObjectVersionNumber":{
            "format":"int32",
            "type":"integer",
            "description":"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":{
            "format":"int32",
            "type":"integer",
            "description":"The sorting order of the analytics dashboard."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorAnalyticsConfigurations-item

Type: object

Show Source

• 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.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier for the agency associated with the dashboard configuration."
        },
        "AnalyticsCode":{
            "maxLength":32,
            "type":"string",
            "description":"The unique identifier for the analytics dashboard configuration."
        },
        "AnalyticsDescription":{
            "maxLength":256,
            "type":"string",
            "description":"Description of the analytics dashboard."
        },
        "AnalyticsPath":{
            "maxLength":1000,
            "type":"string",
            "description":"The path of the analytics dashboard."
        },
        "AnalyticsType":{
            "maxLength":20,
            "type":"string",
            "description":"The type of analytics dashboard."
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the dashboard."
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time that the dashboard was created."
        },
        "DefaultFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Identifies the default analytics dashboard. The default value is false."
        },
        "EnabledFlag":{
            "type":"boolean",
            "description":"Indicates whether the dashboard is available to be used. The default value is false."
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The last date and time that the dashboard was updated."
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login ID of the user who last updated the row."
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the dashboard."
        },
        "ObjectVersionNumber":{
            "format":"int32",
            "type":"integer",
            "description":"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":{
            "format":"int32",
            "type":"integer",
            "description":"The sorting order of the analytics dashboard."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top