Get a violation code reference
get
/fscmRestApi/resources/11.13.18.05/publicSectorSearchViolationCodeReferences/{publicSectorSearchViolationCodeReferencesUniqID}
Request
Path Parameters
-
publicSectorSearchViolationCodeReferencesUniqID: integer
This is the hash key of the attributes which make up the composite key--- AgencyId, IssueTypeId, IssueSubtypeId, CodeReferenceGroupCode, CodeReferenceAgencyId and CodeReferenceCode ---for the Search Violation Code References resource and used to uniquely identify an instance of Search Violation Code References. The client should not generate the hash key value. Instead, the client should query on the Search Violation Code References collection resource with a filter on the primary key values in order to navigate to a specific instance of Search Violation Code References.
For example: publicSectorSearchViolationCodeReferences?q=AgencyId=<value1>;IssueTypeId=<value2>;IssueSubtypeId=<value3>;CodeReferenceGroupCode=<value4>;CodeReferenceAgencyId=<value5>;CodeReferenceCode=<value6>
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 : publicSectorSearchViolationCodeReferences-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
The identifier of the agency.
-
CodeReferenceAgencyId(optional):
integer(int32)
Title:
Agency ID
The identifier of the agency for the violation code reference record. -
CodeReferenceCode(optional):
string
Title:
Code Reference ID
Maximum Length:100
The identifier of the violation code reference. -
CodeReferenceDescription(optional):
string
Title:
Description
The description of the violation code reference. -
CodeReferenceEnabledFlag(optional):
boolean
Title:
Enabled
Indicates whether the violation code reference is available for use. -
CodeReferenceGroupCode(optional):
string
Maximum Length:
100
The identifier of the violation code reference group. -
CodeReferenceGroupCodeEnabledFlag(optional):
boolean
Title:
Enabled
Indicates whether the violation code reference is available for use in the violation code reference group. -
CodeReferenceGroupDescription(optional):
string
Title:
Description
Maximum Length:500
The description of the violation code reference group. -
CodeReferenceGroupEnabledFlag(optional):
boolean
Title:
Enabled
Indicates whether the violation code reference group is available for use. -
CodeReferenceGroupName(optional):
string
Title:
Name
Maximum Length:200
The name of the violation code reference group. -
CodeReferenceName(optional):
string
Title:
Summary
Maximum Length:200
The name of the violation code reference. -
IssueSubtypeId(optional):
string
Maximum Length:
50
The identifier of issue subtype. -
IssueTypeId(optional):
string
Maximum Length:
50
The identifier of issue type. -
links(optional):
array Items
Title:
Items
Link Relations -
SubtypeCodeReferenceGroupEnabledFlag(optional):
string
Maximum Length:
1
Indicates whether the violation code reference group is available for use in the issue sub type.
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.