Jump to

• Request
• Response

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "AnalyticsCode":{
            "title":"Dashboard ID",
            "maxLength":"32",
            "type":"string",
            "description":"The unique identifier for the analytics dashboard configuration.",
            "nullable":false
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The unique identifier for the agency associated with the dashboard configuration.",
            "format":"int32",
            "nullable":true,
            "default":"1",
            "x-hints":{
                "precision":"8"
            }
        },
        "ObjectVersionNumber":{
            "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.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "SortOrder":{
            "title":"Sort Order",
            "type":"integer",
            "description":"The sorting order of the analytics dashboard.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"8"
            }
        },
        "DefaultFlag":{
            "title":"Default",
            "maxLength":"1",
            "type":"string",
            "description":"Identifies the default analytics dashboard. The default value is false.",
            "nullable":true
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the dashboard is available to be used. The default value is false.",
            "nullable":true
        },
        "AnalyticsPath":{
            "title":"Path",
            "maxLength":"1000",
            "type":"string",
            "description":"The path of the analytics dashboard.",
            "nullable":false
        },
        "AnalyticsDescription":{
            "title":"Description",
            "maxLength":"256",
            "type":"string",
            "description":"Description of the analytics dashboard.",
            "nullable":false
        }
    }
}

Back to Top

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.

Body ()

Root Schema : publicSectorAnalyticsConfigurations-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the dashboard.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time that the dashboard was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the dashboard.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AnalyticsCode":{
            "title":"Dashboard ID",
            "maxLength":"32",
            "type":"string",
            "description":"The unique identifier for the analytics dashboard configuration.",
            "nullable":false,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The unique identifier for the agency associated with the dashboard configuration.",
            "format":"int32",
            "nullable":true,
            "default":"1",
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "SortOrder":{
            "title":"Sort Order",
            "type":"integer",
            "description":"The sorting order of the analytics dashboard.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "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.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "AnalyticsType":{
            "title":"Type",
            "maxLength":"20",
            "type":"string",
            "description":"The type of analytics dashboard.",
            "nullable":false,
            "readOnly":true,
            "default":"Dashboard",
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DefaultFlag":{
            "title":"Default",
            "maxLength":"1",
            "type":"string",
            "description":"Identifies the default analytics dashboard. The default value is false.",
            "nullable":true,
            "x-queryable":true
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the dashboard is available to be used. The default value is false.",
            "nullable":true,
            "x-queryable":true
        },
        "AnalyticsPath":{
            "title":"Path",
            "maxLength":"1000",
            "type":"string",
            "description":"The path of the analytics dashboard.",
            "nullable":false,
            "x-queryable":true
        },
        "AnalyticsDescription":{
            "title":"Description",
            "maxLength":"256",
            "type":"string",
            "description":"Description of the analytics dashboard.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The last date and time that the dashboard was updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The login ID of the user who last updated the row.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top