Jump to

• Request
• Response
• Examples

Get an attachment for an award budget

get

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

Request

Path Parameters

• AttachmentsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Award Budget Attachments resource and used to uniquely identify an instance of Award Budget Attachments. The client should not generate the hash key value. Instead, the client should query on the Award Budget Attachments collection resource in order to navigate to a specific instance of Award Budget Attachments to get the hash key.
• PlanVersionId(required): integer(int64)
  Identifier of the award budget version.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

• Metadata-Context: string
  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: string
  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.

There's no request body for this operation.

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

The following example shows how to get an attachment for an award budget by submitting a GET request on the REST resource using cURL.

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

Response Body Example

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

{ "AttachedDocumentId": 300100543169814, "LastUpdateDate": "2021-06-18T09:04:41.336+00:00", "LastUpdatedBy": "Charles.Watson", "DatatypeCode": "FILE", "FileName": "Sample_PDF_batch_2.pdf", "DmFolderPath": null, "DmDocumentId": null, "DmVersionNumber": null, "Url": null, "CategoryName": "PROJECT_BUDGET", "UserName": "Project Budget", "Uri": null, "FileUrl": null, "UploadedText": null, "UploadedFileContentType": null, "UploadedFileLength": null, "UploadedFileName": null, "ContentRepositoryFileShared": "false", "Title": "Sample_PDF_batch_2", "Description": "", "ErrorStatusCode": null, "ErrorStatusMessage": null, "CreatedBy": "Charles.Watson", "CreationDate": "2021-06-18T09:04:41+00:00", "ExpirationDate": null, "LastUpdatedByUserName": "Charles Watson", "CreatedByUserName": "Charles Watson", "AsyncTrackerId": null, "links": [ { "rel": "self", "href": "https://fuscdrmsmc110-fa-ext.us.vision.com:443/fscmRestApi/resources/11.13.18.05/awardBudgets/100100053015964/child/Attachments/00020000000EACED00057708000110F09A45C5160000000EACED00057708000110F09A45C515", "name": "Attachments", "kind": "item" }, { "rel": "canonical", "href": "https://fuscdrmsmc110-fa-ext.us.vision.com:443/fscmRestApi/resources/11.13.18.05/awardBudgets/100100053015964/child/Attachments/00020000000EACED00057708000110F09A45C5160000000EACED00057708000110F09A45C515", "name": "Attachments", "kind": "item" }, { "rel": "parent", "href": "https://fuscdrmsmc110-fa-ext.us.vision.com:443/fscmRestApi/resources/11.13.18.05/awardBudgets/100100053015964", "name": "awardBudgets", "kind": "item" }, { "rel": "enclosure", "href": "https://fuscdrmsmc110-fa-ext.us.vision.com:443/fscmRestApi/resources/11.13.18.05/awardBudgets/100100053015964/child/Attachments/00020000000EACED00057708000110F09A45C5160000000EACED00057708000110F09A45C515/enclosure/FileContents", "name": "FileContents", "kind": "other" }, { "rel": "enclosure", "href": "https://fuscdrmsmc110-fa-ext.us.vision.com:443/fscmRestApi/resources/11.13.18.05/awardBudgets/100100053015964/child/Attachments/00020000000EACED00057708000110F09A45C5160000000EACED00057708000110F09A45C515/enclosure/FileWebImage", "name": "FileWebImage", "kind": "other" } ] }

Back to Top