Jump to

• Request
• Response

Update a mapping attachment revision

patch

/fscmRestApi/resources/11.13.18.05/publicSectorMappingAttachments/{MappingAttachmentKey}/child/MappingAttachmentAccessor/{AttachedDocumentId}/child/AttachmentsRevision/{AttachmentsRevisionUniqID}

Request

Supported Media Types

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

Path Parameters

• AttachedDocumentId: integer
  The unique identifier of the attachment document.
• AttachmentsRevisionUniqID: string
  Identifier to Mapping Attachment Revisions
• MappingAttachmentKey: integer
  The unique identifier associated with the Data Format Exchange mapping attachment.

Body ()

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

Root Schema : publicSectorMappingAttachments-MappingAttachmentAccessor-AttachmentsRevision-item

Type: object

Show Source

• AttachedDocumentId(optional): integer(int64)
  The unique identifier of an attached document.
• ContentId(optional): string
  Maximum Length: 80

  The unique identifier of the attachment content.
• ErrorStatusCode(optional): string
  The code that indicates the error status of the attachment.
• ErrorStatusMessage(optional): string
  The message that describes the error status of the attachment.
• FileUrl(optional): string
  The web address for an attached file.
• Format(optional): string
  Maximum Length: 128

  The format of the attachment.
• InDate(optional): string(date-time)
  Indicates the date when the file was attached.
• links(optional): array Items
  Title: Items

  Link Relations
• RevisionId(optional): string
  Maximum Length: 80

  The unique identifier of the attachment revision.
• RevLabel(optional): string
  Maximum Length: 80

  The label for an attachment revision.
• UserRevisionId(optional): integer(int64)
  The unique identifier for an attachment revision.

{
    "properties":{
        "AttachedDocumentId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of an attached document."
        },
        "ContentId":{
            "maxLength":80,
            "type":"string",
            "description":"The unique identifier of the attachment content."
        },
        "ErrorStatusCode":{
            "type":"string",
            "description":"The code that indicates the error status of the attachment."
        },
        "ErrorStatusMessage":{
            "type":"string",
            "description":"The message that describes the error status of the attachment."
        },
        "FileUrl":{
            "type":"string",
            "description":"The web address for an attached file."
        },
        "Format":{
            "maxLength":128,
            "type":"string",
            "description":"The format of the attachment."
        },
        "InDate":{
            "format":"date-time",
            "type":"string",
            "description":"Indicates the date when the file was attached."
        },
        "RevLabel":{
            "maxLength":80,
            "type":"string",
            "description":"The label for an attachment revision."
        },
        "RevisionId":{
            "maxLength":80,
            "type":"string",
            "description":"The unique identifier of the attachment revision."
        },
        "UserRevisionId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for an attachment revision."
        },
        "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 : publicSectorMappingAttachments-MappingAttachmentAccessor-AttachmentsRevision-item

Type: object

Show Source

• AttachedDocumentId(optional): integer(int64)
  The unique identifier of an attached document.
• ContentId(optional): string
  Maximum Length: 80

  The unique identifier of the attachment content.
• ErrorStatusCode(optional): string
  The code that indicates the error status of the attachment.
• ErrorStatusMessage(optional): string
  The message that describes the error status of the attachment.
• FileUrl(optional): string
  The web address for an attached file.
• Format(optional): string
  Maximum Length: 128

  The format of the attachment.
• InDate(optional): string(date-time)
  Indicates the date when the file was attached.
• links(optional): array Items
  Title: Items

  Link Relations
• RevisionId(optional): string
  Maximum Length: 80

  The unique identifier of the attachment revision.
• RevLabel(optional): string
  Maximum Length: 80

  The label for an attachment revision.
• UserRevisionId(optional): integer(int64)
  The unique identifier for an attachment revision.

{
    "properties":{
        "AttachedDocumentId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of an attached document."
        },
        "ContentId":{
            "maxLength":80,
            "type":"string",
            "description":"The unique identifier of the attachment content."
        },
        "ErrorStatusCode":{
            "type":"string",
            "description":"The code that indicates the error status of the attachment."
        },
        "ErrorStatusMessage":{
            "type":"string",
            "description":"The message that describes the error status of the attachment."
        },
        "FileUrl":{
            "type":"string",
            "description":"The web address for an attached file."
        },
        "Format":{
            "maxLength":128,
            "type":"string",
            "description":"The format of the attachment."
        },
        "InDate":{
            "format":"date-time",
            "type":"string",
            "description":"Indicates the date when the file was attached."
        },
        "RevLabel":{
            "maxLength":80,
            "type":"string",
            "description":"The label for an attachment revision."
        },
        "RevisionId":{
            "maxLength":80,
            "type":"string",
            "description":"The unique identifier of the attachment revision."
        },
        "UserRevisionId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for an attachment revision."
        },
        "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