Update a violation code reference group
patch
/fscmRestApi/resources/11.13.18.05/publicSectorViolationCodeReferenceGroups/{publicSectorViolationCodeReferenceGroupsUniqID}
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Path Parameters
-
publicSectorViolationCodeReferenceGroupsUniqID: integer
This is the hash key of the attributes which make up the composite key--- AgencyId and CodeReferenceGroupCode ---for the Violation Code Reference Groups resource and used to uniquely identify an instance of Violation Code Reference Groups. The client should not generate the hash key value. Instead, the client should query on the Violation Code Reference Groups collection resource with a filter on the primary key values in order to navigate to a specific instance of Violation Code Reference Groups.
For example: publicSectorViolationCodeReferenceGroups?q=AgencyId=<value1>;CodeReferenceGroupCode=<value2>
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorViolationCodeReferenceGroups-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
Title:
Agency ID
The identifier of the agency. -
CodeReferenceGroupCode(optional):
string
Title:
Code Reference Group ID
Maximum Length:100
The violation code reference group code of the record. -
CodeReferences(optional):
array Code References
Title:
Code References
The violation code reference group resource is used to view, create, or modify a violation code reference group. Violation code reference groups are used in Code Enforcement cases. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The name of the user who created the row. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date and time when the row was created. -
Description(optional):
string
Title:
Description
Maximum Length:500
The description of the violation code reference group. -
EnabledFlag(optional):
boolean
Title:
Enabled
Indicates whether the violation code reference group is available for use. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date and time when the row was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The name of the user who last updated the row. -
links(optional):
array Items
Title:
Items
Link Relations -
Name(optional):
string
Title:
Name
Maximum Length:200
The name of the violation code reference group.
Nested Schema : Code References
Type:
array
Title:
Code References
The violation code reference group resource is used to view, create, or modify a violation code reference group. Violation code reference groups are used in Code Enforcement cases.
Show Source
Nested Schema : publicSectorViolationCodeReferenceGroups-CodeReferences-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
Title:
Agency ID
The identifier of the agency. -
CodeReferenceCode(optional):
string
Title:
Code Reference ID
Maximum Length:100
The violation code reference code of the record. -
CodeReferenceGroupCode(optional):
string
Title:
Code Reference Group ID
Maximum Length:100
The violation code reference group code of the record. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The name of the user who created the row. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date and time when the row was created. -
EnabledFlag(optional):
boolean
Title:
Enabled
Indicates whether the violation code reference is available for use in the group. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date and time when the row was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The name of the user who last updated the row. -
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.
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 : publicSectorViolationCodeReferenceGroups-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
Title:
Agency ID
The identifier of the agency. -
CodeReferenceGroupCode(optional):
string
Title:
Code Reference Group ID
Maximum Length:100
The violation code reference group code of the record. -
CodeReferences(optional):
array Code References
Title:
Code References
The violation code reference group resource is used to view, create, or modify a violation code reference group. Violation code reference groups are used in Code Enforcement cases. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The name of the user who created the row. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date and time when the row was created. -
Description(optional):
string
Title:
Description
Maximum Length:500
The description of the violation code reference group. -
EnabledFlag(optional):
boolean
Title:
Enabled
Indicates whether the violation code reference group is available for use. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date and time when the row was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The name of the user who last updated the row. -
links(optional):
array Items
Title:
Items
Link Relations -
Name(optional):
string
Title:
Name
Maximum Length:200
The name of the violation code reference group.
Nested Schema : Code References
Type:
array
Title:
Code References
The violation code reference group resource is used to view, create, or modify a violation code reference group. Violation code reference groups are used in Code Enforcement cases.
Show Source
Nested Schema : publicSectorViolationCodeReferenceGroups-CodeReferences-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
Title:
Agency ID
The identifier of the agency. -
CodeReferenceCode(optional):
string
Title:
Code Reference ID
Maximum Length:100
The violation code reference code of the record. -
CodeReferenceGroupCode(optional):
string
Title:
Code Reference Group ID
Maximum Length:100
The violation code reference group code of the record. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The name of the user who created the row. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date and time when the row was created. -
EnabledFlag(optional):
boolean
Title:
Enabled
Indicates whether the violation code reference is available for use in the group. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date and time when the row was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The name of the user who last updated the row. -
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.