Jump to

• Request
• Response

Update an attachment cross-reference

patch

/fscmRestApi/resources/11.13.18.05/publicSectorIntakeAttachmentCrossReferences/{publicSectorIntakeAttachmentCrossReferencesUniqID}

Request

Supported Media Types

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

Path Parameters

• publicSectorIntakeAttachmentCrossReferencesUniqID: integer
  This is the hash key of the attributes which make up the composite key--- AttXrefKey and AttXrefTransKey ---for the Intake Attachment Cross-References resource and used to uniquely identify an instance of Intake Attachment Cross-References. The client should not generate the hash key value. Instead, the client should query on the Intake Attachment Cross-References collection resource with a filter on the primary key values in order to navigate to a specific instance of Intake Attachment Cross-References.
  
  For example: publicSectorIntakeAttachmentCrossReferences?q=AttXrefKey=<value1>;AttXrefTransKey=<value2>

Body ()

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

Root Schema : publicSectorIntakeAttachmentCrossReferences-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  The agency identifier.
• AttXrefKey(optional): integer(int64)
  The attachment cross-reference key.
• AttXrefTransKey(optional): integer(int64)
  The attachment cross-reference transaction key.
• CreatedBy(optional): string
  Maximum Length: 64

  The name of the user who created the row.
• CreationDate(optional): string(date-time)
  The date and time when the row was created.
• LastUpdateDate(optional): string(date-time)
  The date and time when the row was last updated.
• LastUpdatedBy(optional): string
  Maximum Length: 64

  The name of the user who last updated the row.
• LastUpdateLogin(optional): string
  Maximum Length: 32

  The login ID of the user who last updated the row.
• links(optional): array Items
  Title: Items

  Link Relations
• ObjectVersionNumber(optional): integer(int32)
  The version number used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The agency identifier."
        },
        "AttXrefKey":{
            "format":"int64",
            "type":"integer",
            "description":"The attachment cross-reference key."
        },
        "AttXrefTransKey":{
            "format":"int64",
            "type":"integer",
            "description":"The attachment cross-reference transaction key."
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the row."
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was created."
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was last updated."
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login ID of the user who last updated the row."
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the row."
        },
        "ObjectVersionNumber":{
            "format":"int32",
            "type":"integer",
            "description":"The version number used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried."
        },
        "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 : publicSectorIntakeAttachmentCrossReferences-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  The agency identifier.
• AttXrefKey(optional): integer(int64)
  The attachment cross-reference key.
• AttXrefTransKey(optional): integer(int64)
  The attachment cross-reference transaction key.
• CreatedBy(optional): string
  Maximum Length: 64

  The name of the user who created the row.
• CreationDate(optional): string(date-time)
  The date and time when the row was created.
• LastUpdateDate(optional): string(date-time)
  The date and time when the row was last updated.
• LastUpdatedBy(optional): string
  Maximum Length: 64

  The name of the user who last updated the row.
• LastUpdateLogin(optional): string
  Maximum Length: 32

  The login ID of the user who last updated the row.
• links(optional): array Items
  Title: Items

  Link Relations
• ObjectVersionNumber(optional): integer(int32)
  The version number used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The agency identifier."
        },
        "AttXrefKey":{
            "format":"int64",
            "type":"integer",
            "description":"The attachment cross-reference key."
        },
        "AttXrefTransKey":{
            "format":"int64",
            "type":"integer",
            "description":"The attachment cross-reference transaction key."
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the row."
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was created."
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was last updated."
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login ID of the user who last updated the row."
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the row."
        },
        "ObjectVersionNumber":{
            "format":"int32",
            "type":"integer",
            "description":"The version number used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried."
        },
        "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