Jump to

• Request
• Response

Get all document groups

get

/fscmRestApi/resources/11.13.18.05/publicSectorDocumentGroups

Request

Query Parameters

• dependency: string
  This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the attributes will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency attributes. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource attributes. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • simpleSearchFinder: Finds the document groups that match the specified search criteria. Finder Variables:
    • value; string; The value used to search for a document group.
  • PrimaryKey: The key criteria used to select a document group. Finder Variables:
    • AgencyId; integer; The agency identifier of the public sector entity to which this document group applies.
    • DocumentGroupId; string; The unique identifier of the document group.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Back to Top

Response

Supported Media Types

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

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorDocumentGroups

Type: object

Show Source

• count(optional): integer
  Title: Count

  The number of resource instances returned in the current range.
• hasMore(optional): boolean
  Title: HasMore

  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items(optional): array Items
  Title: Items

  The items in the collection.
• limit(optional): integer
  Title: Limit

  The actual paging size used by the server.
• links(optional): array Items
  Title: Items

  The link relations associated with the resource instance.
• offset(optional): integer
  Title: Offset

  The offset value used in the current page.

{
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range.",
            "title":"Count"
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.",
            "title":"HasMore"
        },
        "items":{
            "items":{
                "$ref":"#/definitions/publicSectorDocumentGroups-item"
            },
            "type":"array",
            "description":"The items in the collection.",
            "title":"Items"
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server.",
            "title":"Limit"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "title":"Items"
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page.",
            "title":"Offset"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object publicSectorDocumentGroups-item

{
    "items":{
        "$ref":"#/definitions/publicSectorDocumentGroups-item"
    },
    "type":"array",
    "description":"The items in the collection.",
    "title":"Items"
}

Nested Schema : Items

Type: array

Title: Items

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : publicSectorDocumentGroups-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Title: Agency ID

  The agency identifier of the public sector entity to which this document group applies.
• CreationDate(optional): string(date-time)
  The timestamp on which the document group was created.
• Description(optional): string
  Title: Description

  Maximum Length: 500

  Indicates the value that will describe the document group.
• DocumentGroup(optional): string
  Title: Group

  Maximum Length: 25

  Indicates the value that will be displayed for document group.
• DocumentGroupCategory(optional): array Document Group Categories
  Title: Document Group Categories

  Use the document group categories resource to view, update, create, and delete document group categories. A document group category is used to specify document categories that are part of a document group definition.
• DocumentGroupId(optional): string
  Title: Group ID

  Maximum Length: 30

  The unique identifier for the document group.
• EnabledFlag(optional): boolean
  Title: Enabled

  Indicates if the document group is enabled or not for selection in attachments. If True the document group is enabled and valid document category values then can be selected. If false the document group will have any valid document category values that can be selected. Default value is false.
• LastUpdateDate(optional): string(date-time)
  The timestamp on which the document group was last modified.
• links(optional): array Items
  Title: Items

  Link Relations

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The agency identifier of the public sector entity to which this document group applies.",
            "title":"Agency ID"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The timestamp on which the document group was created."
        },
        "Description":{
            "maxLength":500,
            "type":"string",
            "description":"Indicates the value that will describe the document group.",
            "title":"Description"
        },
        "DocumentGroup":{
            "maxLength":25,
            "type":"string",
            "description":"Indicates the value that will be displayed for document group.",
            "title":"Group"
        },
        "DocumentGroupCategory":{
            "items":{
                "$ref":"#/definitions/publicSectorDocumentGroups-DocumentGroupCategory-item"
            },
            "type":"array",
            "description":"Use the document group categories resource to view, update, create, and delete document group categories. A document group category is used to specify document categories that are part of a document group definition.",
            "title":"Document Group Categories"
        },
        "DocumentGroupId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the document group.",
            "title":"Group ID"
        },
        "EnabledFlag":{
            "type":"boolean",
            "description":"Indicates if the document group is enabled or not for selection in attachments.  If True the document group is enabled and valid document category values then can be selected. If false the document group will have any valid document category values that can be selected.  Default value is false.",
            "title":"Enabled"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The timestamp on which the document group was last modified."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Document Group Categories

Type: array

Title: Document Group Categories

Use the document group categories resource to view, update, create, and delete document group categories. A document group category is used to specify document categories that are part of a document group definition.

Show Source

• Array of: object publicSectorDocumentGroups-DocumentGroupCategory-item

{
    "items":{
        "$ref":"#/definitions/publicSectorDocumentGroups-DocumentGroupCategory-item"
    },
    "type":"array",
    "description":"Use the document group categories resource to view, update, create, and delete document group categories. A document group category is used to specify document categories that are part of a document group definition.",
    "title":"Document Group Categories"
}

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 : publicSectorDocumentGroups-DocumentGroupCategory-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Title: Agency ID

  The agency identifier of the public sector entity to which this document group category applies.
• CreationDate(optional): string(date-time)
  The date when the document category group was created.
• DocumentCategory(optional): string
  Title: Category ID

  Maximum Length: 30

  The unique identifier for the document category group.
• DocumentGroupId(optional): string
  Title: Group ID

  Maximum Length: 30

  The unique identifier for the document group.
• EnabledFlag(optional): boolean
  Title: Enabled

  Indicates whether the document group category is enabled or not for selection in attachments. If true, the document group category is enabled and is a valid value that can be selected as a document category for an attachment. If false, the document group category is not a valid value that can be selected as a document category for an attachment. The default value is false.
• LastUpdateDate(optional): string(date-time)
  The date when the document category group was last modified.
• links(optional): array Items
  Title: Items

  Link Relations

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The agency identifier of the public sector entity to which this document group category applies.",
            "title":"Agency ID"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the document category group was created."
        },
        "DocumentCategory":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the document category group.",
            "title":"Category ID"
        },
        "DocumentGroupId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the document group.",
            "title":"Group ID"
        },
        "EnabledFlag":{
            "type":"boolean",
            "description":"Indicates whether the document group category is enabled or not for selection in attachments. If true, the document group category is enabled and is a valid value that can be selected as a document category for an attachment. If false, the document group category is not a valid value that can be selected as a document category for an attachment. The default value is false.",
            "title":"Enabled"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the document category group was last modified."
        },
        "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