Jump to

• Request
• Response

Get a violation code reference

get

/fscmRestApi/resources/11.13.18.05/publicSectorViolationCodeReferences/{publicSectorViolationCodeReferencesUniqID}

Request

Path Parameters

• publicSectorViolationCodeReferencesUniqID: integer
  This is the hash key of the attributes which make up the composite key--- AgencyId and CodeReferenceCode ---for the Violation Code References resource and used to uniquely identify an instance of Violation Code References. The client should not generate the hash key value. Instead, the client should query on the Violation Code References collection resource with a filter on the primary key values in order to navigate to a specific instance of Violation Code References.
  
  For example: publicSectorViolationCodeReferences?q=AgencyId=<value1>;CodeReferenceCode=<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).

Back to Top

Response

Supported Media Types

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

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorViolationCodeReferences-item

Type: object

Show Source

• 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.
• CorrectiveActionCode(optional): string
  Title: Corrective Action

  Maximum Length: 100

  The corrective action 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.
• Description(optional): string
  Title: Description

  The description of the violation code reference.
• EnabledFlag(optional): boolean
  Title: Enabled

  Indicates whether the violation code reference 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: Summary

  Maximum Length: 200

  The name of the violation code reference.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The identifier of the agency.",
            "title":"Agency ID"
        },
        "CodeReferenceCode":{
            "maxLength":100,
            "type":"string",
            "description":"The violation code reference code of the record.",
            "title":"Code Reference ID"
        },
        "CorrectiveActionCode":{
            "maxLength":100,
            "type":"string",
            "description":"The corrective action code of the record.",
            "title":"Corrective Action"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the row.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was created.",
            "title":"Creation Date"
        },
        "Description":{
            "type":"string",
            "description":"The description of the violation code reference.",
            "title":"Description"
        },
        "EnabledFlag":{
            "type":"boolean",
            "description":"Indicates whether the violation code reference is available for use.",
            "title":"Enabled"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "title":"Last Updated By"
        },
        "Name":{
            "maxLength":200,
            "type":"string",
            "description":"The name of the violation code reference.",
            "title":"Summary"
        },
        "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