Jump to

• Request
• Response

Update a deposit account attachment data

patch

/fscmRestApi/resources/11.13.18.05/publicSectorDepositAccountDocuments/{DepositAttachmentKey}

Request

Path Parameters

• DepositAttachmentKey(required): integer(int64)
  The unique system-generated numeric identifier of the deposit account attachment.

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

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

Root Schema : schema

Type: object

Show Source

• AttachmentId: integer (int64)
  The attachment identifier from the common attachment table.
• DepositAccountKey: integer (int64)
  The unique system-generated numeric identifier of the deposit account.
• DepositAccountNumber: string
  Maximum Length: 30

  The unique agency-defined alphanumeric identifier of the deposit account.
• DocCategory: string
  Maximum Length: 30

  The category information of the attached document.
• DocSubcategory: string
  Maximum Length: 30

  The subcategory for an attached document.

{
    "type":"object",
    "properties":{
        "DepositAccountNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The unique agency-defined alphanumeric identifier of the deposit account.",
            "nullable":false
        },
        "DepositAccountKey":{
            "type":"integer",
            "description":"The unique system-generated numeric identifier of the deposit account.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "DocCategory":{
            "maxLength":30,
            "type":"string",
            "description":"The category information of the attached document.",
            "nullable":true
        },
        "AttachmentId":{
            "type":"integer",
            "description":"The attachment identifier from the common attachment table.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "DocSubcategory":{
            "maxLength":30,
            "type":"string",
            "description":"The subcategory for an attached document.",
            "nullable":true
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version(required):
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : publicSectorDepositAccountDocuments-item-response

Type: object

Show Source

• AttachmentId: integer (int64)
  The attachment identifier from the common attachment table.
• DepositAccountKey: integer (int64)
  The unique system-generated numeric identifier of the deposit account.
• DepositAccountNumber: string
  Maximum Length: 30

  The unique agency-defined alphanumeric identifier of the deposit account.
• DepositAttachmentKey: integer (int64)
  The unique system-generated numeric identifier of the deposit account attachment.
• DocCategory: string
  Maximum Length: 30

  The category information of the attached document.
• DocSubcategory: string
  Maximum Length: 30

  The subcategory for an attached document.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "DepositAccountNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The unique agency-defined alphanumeric identifier of the deposit account.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DepositAttachmentKey":{
            "type":"integer",
            "description":"The unique system-generated numeric identifier of the deposit account attachment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "DepositAccountKey":{
            "type":"integer",
            "description":"The unique system-generated numeric identifier of the deposit account.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DocCategory":{
            "maxLength":30,
            "type":"string",
            "description":"The category information of the attached document.",
            "nullable":true,
            "x-queryable":true
        },
        "AttachmentId":{
            "type":"integer",
            "description":"The attachment identifier from the common attachment table.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DocSubcategory":{
            "maxLength":30,
            "type":"string",
            "description":"The subcategory for an attached document.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top