Get a document group
get
/fscmRestApi/resources/11.13.18.05/publicSectorDocumentGroups/{publicSectorDocumentGroupsUniqID}
Request
Path Parameters
-
publicSectorDocumentGroupsUniqID: integer
This is the hash key of the attributes which make up the composite key--- AgencyId and DocumentGroupId ---for the Document Groups resource and used to uniquely identify an instance of Document Groups. The client should not generate the hash key value. Instead, the client should query on the Document Groups collection resource with a filter on the primary key values in order to navigate to a specific instance of Document Groups.
For example: publicSectorDocumentGroups?q=AgencyId=<value1>;DocumentGroupId=<value2>
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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 : publicSectorDocumentGroups-item
Type:
Show Source
object
-
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 document groups resource to view, update, create, and delete document groups. A document group is used to organize document categories that an uploaded attachment can be associated with. -
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
Nested Schema : Document Group Categories
Type:
array
Title:
Document Group Categories
Use document groups resource to view, update, create, and delete document groups. A document group is used to organize document categories that an uploaded attachment can be associated with.
Show Source
Nested Schema : publicSectorDocumentGroups-DocumentGroupCategory-item
Type:
Show Source
object
-
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
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.