Jump to

• Request
• Response
• Examples

Create an attachment for an award budget

post

/fscmRestApi/resources/11.13.18.05/awardBudgets/{PlanVersionId}/child/Attachments

Request

Path Parameters

• PlanVersionId(required): integer(int64)
  Identifier of the award budget version.

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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  The unique identifier of the attached document.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  The category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  A value that indicates the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  The document ID from which the attachment is created.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  The folder path from which the attachment is created.
• DmVersionNumber: string
  Maximum Length: 255

  The document version number from which the attachment is created.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  The error code, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  The error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  The expiration date of the contents in the attachment.
• FileContents: string (byte)
  Title: File Contents

  The contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  The file name of the attachment.
• FileUrl: string
  Title: File Url

  The URI of the file.
• PostProcessingAction: string
  Title: PostProcessingAction

  The name of the action that can be performed after an attachment is uploaded.
• Title: string
  Title: Title

  The title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  The content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  The size of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  The name to assign to a new attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text content for a new text attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of a Topology Manager type attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of a web page type attachment.

{
    "type":"object",
    "properties":{
        "Description":{
            "title":"Description",
            "maxLength":"255",
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":"2048",
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":"4000",
            "type":"string",
            "description":"The URI of a Topology Manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Url":{
            "title":"Url",
            "maxLength":"4000",
            "type":"string",
            "description":"The URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "DmDocumentId":{
            "maxLength":"255",
            "type":"string",
            "description":"The document ID from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The unique identifier of the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"The document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"A value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":"1000",
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":"30",
            "type":"string",
            "description":"The category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• 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.

Body ()

Root Schema : awardBudgets-Attachments-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  The unique identifier of the attached document.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  The category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  The user who created the record.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

  The user name who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the record was created.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  A value that indicates the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  The document ID from which the attachment is created.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  The folder path from which the attachment is created.
• DmVersionNumber: string
  Maximum Length: 255

  The document version number from which the attachment is created.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  The error code, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  The error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  The expiration date of the contents in the attachment.
• FileContents: string (byte)
  Title: File Contents

  The contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  The file name of the attachment.
• FileUrl: string
  Title: File Url

  The URI of the file.
• FileWebImage: string (byte)
  Title: File Web Image

  Read Only: true

  The base64 encoded image of the file displayed in .png format if the source is a convertible image.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  The user who last updated the record.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  The user name who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PostProcessingAction: string
  Title: PostProcessingAction

  The name of the action that can be performed after an attachment is uploaded.
• Title: string
  Title: Title

  The title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  The content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  The size of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  The name to assign to a new attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text content for a new text attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of a Topology Manager type attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of a web page type attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  The login credentials of the user who created the attachment.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"255",
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":"2048",
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"The base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":"4000",
            "type":"string",
            "description":"The URI of a Topology Manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":"4000",
            "type":"string",
            "description":"The URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":"255",
            "type":"string",
            "description":"The document ID from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The unique identifier of the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"The user name who created the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"The document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"255",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UserName":{
            "title":"User Name",
            "maxLength":"255",
            "type":"string",
            "description":"The login credentials of the user who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"255",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"A value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"The user name who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":"1000",
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":"30",
            "type":"string",
            "description":"The category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

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

Examples

Example 1

The following example shows how to create an attachment for an award budget for a data type code of FILE by submitting a POST request on the REST resource using cURL. You can attach documents and media using this data type code.

curl --user ppm_cloud_user -X POST -d @example_request_payload.json "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardBudgets/<PlanVersionId>/child/Attachments" -H 'cache-control: no-cache'

Request Body Example

The following shows an example of the request body in JSON format.

{
"CategoryName": "PROJECT_BUDGET",
"DatatypeCode": "FILE",
"FileContents": "VGVzdCBjb250ZW50IHVwZGF0ZWQ=",
"Title" : "Sample File attachment",
"FileName": "File_Attachment.txt"
}

Response Body Example

The following shows an example of the response body in JSON format.

{
    "AttachedDocumentId": 300100544191976,
    "LastUpdateDate": "2021-06-23T03:08:15.268+00:00",
    "LastUpdatedBy": "Charles.Watson",
    "DatatypeCode": "FILE",
    "FileName": "File_Attachment.txt",
    "DmFolderPath": null,
    "DmDocumentId": "UCMFA00087406",
    "DmVersionNumber": "87406",
    "Url": null,
    "CategoryName": "PROJECT_BUDGET",
    "UserName": null,
    "Uri": null,
    "FileUrl": "/content/conn/FusionAppsContentRepository/uuid/dDocID%3a87406?XFND_SCHEME_ID=1&XFND_CERT_FP=01A8AFB3277D68B1E0D8CFC44C59578044ADBAE0&XFND_RANDOM=8828894683116890821&XFND_EXPIRES=1624418295869&XFND_SIGNATURE=WXPO5Dz9rc3c9mh06rTp3n5uUB~MNS1v40SZ3wn4C2V-lvDWPA2LQ5RtRy7jJ8clSOlwTkR37H9Fv61HlfyAAM5tEsFXcBJcsuvyy595vj-6auYg1vaWz-026XyyHSL-rjmg-o9KAW3-egshX1yvihu0npbTqRqlqAdmY8rpdqknYLbeEFJilcicXVs~a~eyTxoOmOMgxiwHU4oHjDENMV~a~WyoK69pbUpXw-1EqXRrUYyssVFGhCVMztMVZ6gueOpEN7PkjY62IMNwe2S-n4fSWrD5pBo66Tu21OOHmMljrMQP9uxIv62gOJa9US9-Jc7sNV0dDHlorg4KhHn8GQ__&Id=87406&download",
    "UploadedText": null,
    "UploadedFileContentType": "text/plain",
    "UploadedFileLength": 20,
    "UploadedFileName": "File_Attachment.txt",
    "ContentRepositoryFileShared": "false",
    "Title": "Sample File attachment",
    "Description": "",
    "ErrorStatusCode": null,
    "ErrorStatusMessage": null,
    "CreatedBy": "Charles.Watson",
    "CreationDate": "2021-06-23T03:08:13+00:00",
    "ExpirationDate": null,
    "LastUpdatedByUserName": "Charles Watson",
    "CreatedByUserName": "Charles Watson",
    "AsyncTrackerId": null,
    "links": [
        {
            "rel": "self",
            "href": "https://fphchyb13.fa.dc1.c9dev2.visioncorp.com:443/fscmRestApi/resources/11.13.18.05/awardBudgets/100100053015964/child/Attachments/00020000000EACED00057708000110F09A555DE80000000EACED00057708000110F09A555DE7",
            "name": "Attachments",
            "kind": "item"
        },
        {
            "rel": "canonical",
            "href": "https://fphchyb13.fa.dc1.c9dev2.visioncorp.com:443/fscmRestApi/resources/11.13.18.05/awardBudgets/100100053015964/child/Attachments/00020000000EACED00057708000110F09A555DE80000000EACED00057708000110F09A555DE7",
            "name": "Attachments",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "https://fphchyb13.fa.dc1.c9dev2.visioncorp.com:443/fscmRestApi/resources/11.13.18.05/awardBudgets/100100053015964",
            "name": "awardBudgets",
            "kind": "item"
        },
        {
            "rel": "enclosure",
            "href": "https://fphchyb13.fa.dc1.c9dev2.visioncorp.com:443/fscmRestApi/resources/11.13.18.05/awardBudgets/100100053015964/child/Attachments/00020000000EACED00057708000110F09A555DE80000000EACED00057708000110F09A555DE7/enclosure/FileContents",
            "name": "FileContents",
            "kind": "other"
        },
        {
            "rel": "enclosure",
            "href": "https://fphchyb13.fa.dc1.c9dev2.visioncorp.com:443/fscmRestApi/resources/11.13.18.05/awardBudgets/100100053015964/child/Attachments/00020000000EACED00057708000110F09A555DE80000000EACED00057708000110F09A555DE7/enclosure/FileWebImage",
            "name": "FileWebImage",
            "kind": "other"
        }
    ]
}

Example 2

The following example shows how to create an attachment for an award budget for a data type code of TEXT by submitting a POST request on the REST resource using cURL. You can attach text only files using this data type code.

curl --user ppm_cloud_user -X POST -d @example_request_payload.json "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardBudgets/<PlanVersionId>/child/Attachments" -H 'cache-control: no-cache'

Request Body Example

The following shows an example of the request body in JSON format.

{
"DatatypeCode" : "TEXT",
"CategoryName" : "PROJECT_BUDGET",
"UploadedText" : "This is a sample text attachment",
"Title" : "REST Attachment Text",
"Description" : "Text Attachment"
}

Response Body Example

The following shows an example of the response body in JSON format.

{
    "AttachedDocumentId": 300100544161058,
    "LastUpdateDate": "2021-06-23T03:09:57.208+00:00",
    "LastUpdatedBy": "Charles.Watson",
    "DatatypeCode": "TEXT",
    "FileName": "This is a sample text attachme...",
    "DmFolderPath": null,
    "DmDocumentId": "UCMFA00087414",
    "DmVersionNumber": "87414",
    "Url": null,
    "CategoryName": "PROJECT_BUDGET",
    "UserName": null,
    "Uri": null,
    "FileUrl": "/content/conn/FusionAppsContentRepository/uuid/dDocID%3a87414?XFND_SCHEME_ID=1&XFND_CERT_FP=01A8AFB3277D68B1E0D8CFC44C59578044ADBAE0&XFND_RANDOM=4043996416184598307&XFND_EXPIRES=1624418397638&XFND_SIGNATURE=Bzh5L92CybIB3JXkx29O0brUOO6aNDdV3u1vgi7BsrDnUOFjw1dNN40AGHW5j6Axi7P6CHGLt5-3~nxrIKtWAwEeO5fkwtASMuT8wzmUabchZUE0kb6ZLWeAAiN3MSVm-n7aMJp0cyuzU7DpsK9bi8OzmDR~nX6dNymE~rAmt3I4oLZnk7SHO-4w9onZ~aehiFrr6j-wHSN~EPASG4zJgiEDegzFLx2GCC-nDEZjK6ntViUGBnLJ0ZS6gNOShFocmbUYz9euVYSISHWtzi2BO64E80A4GjAg1zvkuWnJPgcqbuQNOoM0KwtsnLjhncVRyIUbrT6PHD4JktoPUz~NGQ__&Id=87414&download",
    "UploadedText": null,
    "UploadedFileContentType": "text/plain",
    "UploadedFileLength": 35,
    "UploadedFileName": "REST Attachment Text-37f588b2-a4d8-4030-8876-4403fcd77b4e.txt",
    "ContentRepositoryFileShared": "false",
    "Title": "REST Attachment Text",
    "Description": "Text Attachment",
    "ErrorStatusCode": null,
    "ErrorStatusMessage": null,
    "CreatedBy": "Charles.Watson",
    "CreationDate": "2021-06-23T03:09:56+00:00",
    "ExpirationDate": null,
    "LastUpdatedByUserName": "Charles Watson",
    "CreatedByUserName": "Charles Watson",
    "AsyncTrackerId": null,
    "links": [
        {
            "rel": "self",
            "href": "https://fphchyb13.fa.dc1.c9dev2.visioncorp.com:443/fscmRestApi/resources/11.13.18.05/awardBudgets/100100053015964/child/Attachments/00020000000EACED00057708000110F09A54E5220000000EACED00057708000110F09A54E521",
            "name": "Attachments",
            "kind": "item"
        },
        {
            "rel": "canonical",
            "href": "https://fphchyb13.fa.dc1.c9dev2.visioncorp.com:443/fscmRestApi/resources/11.13.18.05/awardBudgets/100100053015964/child/Attachments/00020000000EACED00057708000110F09A54E5220000000EACED00057708000110F09A54E521",
            "name": "Attachments",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "https://fphchyb13.fa.dc1.c9dev2.visioncorp.com:443/fscmRestApi/resources/11.13.18.05/awardBudgets/100100053015964",
            "name": "awardBudgets",
            "kind": "item"
        },
        {
            "rel": "enclosure",
            "href": "https://fphchyb13.fa.dc1.c9dev2.visioncorp.com:443/fscmRestApi/resources/11.13.18.05/awardBudgets/100100053015964/child/Attachments/00020000000EACED00057708000110F09A54E5220000000EACED00057708000110F09A54E521/enclosure/FileContents",
            "name": "FileContents",
            "kind": "other"
        },
        {
            "rel": "enclosure",
            "href": "https://fphchyb13.fa.dc1.c9dev2.visioncorp.com:443/fscmRestApi/resources/11.13.18.05/awardBudgets/100100053015964/child/Attachments/00020000000EACED00057708000110F09A54E5220000000EACED00057708000110F09A54E521/enclosure/FileWebImage",
            "name": "FileWebImage",
            "kind": "other"
        }
    ]
}

Example 3

The following example shows how to create an attachment for an award budget for a data type code of WEB_PAGE by submitting a POST request on the REST resource using cURL. You can attach URLs and page links using this data type code.

curl --user ppm_cloud_user -X POST -d @example_request_payload.json "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/awardBudgets/<PlanVersionId>/child/Attachments" -H 'cache-control: no-cache'

Request Body Example

The following shows an example of the request body in JSON format.

{
"DatatypeCode" : "WEB_PAGE",
"CategoryName" : "PROJECT_BUDGET",
"Url" : "http://www.resturlattachmenttest.com",
"ContentRepositoryFileShared" : "false",
"Title" : "Web Page attachment",
"Description" : "Web Page attachment"
}

Response Body Example

The following shows an example of the response body in JSON format.

{
    "AttachedDocumentId": 300100544162059,
    "LastUpdateDate": "2021-06-23T03:09:37.204+00:00",
    "LastUpdatedBy": "Charles.Watson",
    "DatatypeCode": "WEB_PAGE",
    "FileName": null,
    "DmFolderPath": "",
    "DmDocumentId": null,
    "DmVersionNumber": null,
    "Url": "http://www.resturlattachmenttest.com",
    "CategoryName": "PROJECT_BUDGET",
    "UserName": null,
    "Uri": null,
    "FileUrl": null,
    "UploadedText": null,
    "UploadedFileContentType": null,
    "UploadedFileLength": null,
    "UploadedFileName": null,
    "ContentRepositoryFileShared": "false",
    "Title": "Web Page attachment",
    "Description": "Web Page attachment",
    "ErrorStatusCode": null,
    "ErrorStatusMessage": null,
    "CreatedBy": "Charles.Watson",
    "CreationDate": "2021-06-23T03:09:37+00:00",
    "ExpirationDate": null,
    "LastUpdatedByUserName": "Charles Watson",
    "CreatedByUserName": "Charles Watson",
    "AsyncTrackerId": null,
    "links": [
        {
            "rel": "self",
            "href": "https://fphchyb13.fa.dc1.c9dev2.visioncorp.com:443/fscmRestApi/resources/11.13.18.05/awardBudgets/100100053015964/child/Attachments/00020000000EACED00057708000110F09A54E90B0000000EACED00057708000110F09A54E90A",
            "name": "Attachments",
            "kind": "item"
        },
        {
            "rel": "canonical",
            "href": "https://fphchyb13.fa.dc1.c9dev2.visioncorp.com:443/fscmRestApi/resources/11.13.18.05/awardBudgets/100100053015964/child/Attachments/00020000000EACED00057708000110F09A54E90B0000000EACED00057708000110F09A54E90A",
            "name": "Attachments",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "https://fphchyb13.fa.dc1.c9dev2.visioncorp.com:443/fscmRestApi/resources/11.13.18.05/awardBudgets/100100053015964",
            "name": "awardBudgets",
            "kind": "item"
        },
        {
            "rel": "enclosure",
            "href": "https://fphchyb13.fa.dc1.c9dev2.visioncorp.com:443/fscmRestApi/resources/11.13.18.05/awardBudgets/100100053015964/child/Attachments/00020000000EACED00057708000110F09A54E90B0000000EACED00057708000110F09A54E90A/enclosure/FileContents",
            "name": "FileContents",
            "kind": "other"
        },
        {
            "rel": "enclosure",
            "href": "https://fphchyb13.fa.dc1.c9dev2.visioncorp.com:443/fscmRestApi/resources/11.13.18.05/awardBudgets/100100053015964/child/Attachments/00020000000EACED00057708000110F09A54E90B0000000EACED00057708000110F09A54E90A/enclosure/FileWebImage",
            "name": "FileWebImage",
            "kind": "other"
        }
    ]
}

Back to Top