Jump to

• Request
• Response

Update a violation code reference

patch

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

Request

Supported Media Types

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

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>

Body ()

The following table describes the body parameters in the request for this task.

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

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