Jump to

• Request
• Response

Get a project attachment

get

/fscmRestApi/resources/11.13.18.05/publicSectorProjectAttachments/{AttachmentKey}

Request

Path Parameters

• AttachmentKey(required): integer
  The unique identifier for the project attachment row.

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

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 : publicSectorProjectAttachments-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  The unique identifier of the public sector agency.
• AttachmentEntityName: string
  Maximum Length: 255

  Default Value: PSC_DOC_PRO

  The unique identifier to indicate project attachments(PSC_DOC_PRO) used by the attachment component.
• AttachmentId: integer (int64)
  The unique identifier of the attachment from the common attachment table.
• AttachmentKey: integer
  The unique identifier for the project attachment row.
• AttachmentType: string
  Maximum Length: 15

  Default Value: PRO

  The attachment type to identify project attachments. The values is PRO.
• ConfidentialFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates whether the attachment is a confidential document. The default value is N for no.
• CreatedByName: string
  Title: Uploaded By

  The name of the user who created the attachment.
• CreationDate: string (date-time)
  Title: Uploaded On

  Read Only: true

  The date and time when the attachment was created.
• Description: string
  Title: Description

  Maximum Length: 100

  The description for the file attached.
• DocumentCategory: string
  Title: Category

  Maximum Length: 30

  The unique identifier for the document category.
• DocumentGroupId: string
  Maximum Length: 30

  The unique identifier for the document group.
• DocumentSubcategory: string
  Title: Subcategory

  Maximum Length: 30

  The unique identifier for the document subcategory.
• FileName: string
  Title: File Name

  Maximum Length: 255

  The name of the file attached.
• FileSize: integer (int64)
  Title: File Size

  The size of the file attached.
• FileType: string
  Maximum Length: 100

  The type of the file attached whether text/plain, image/jpeg and so on.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the attachment was last updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Preview: string (byte)
  This column contains the thumbnail of an attached file.
• PreviewHeight: number
  This column indicates the height of a stored thumbnail.
• PreviewWidth: number
  This column indicates the width of a stored thumbnail.
• ProjectAgencyId: integer (int32)
  The unique identifier of the public sector agency.
• ProjectAttachmentAccessor: array Project Attachment Accessors
  Title: Project Attachment Accessors

  The project attachment accessor resource is used for displaying file-related information such as file name and file URL.
• ProjectAttachmentId: integer (int64)
  The unique identifier of the attachment from the common attachment table.
• ProjectCode: string
  Title: Project ID

  Maximum Length: 30

  The unique identifier of the project.
• RequiredFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates whether the attachment is a required document. The default value is N for no.
• UpdatedByName: string
  Title: Last Updated By

  The name of the user who last updated the attachment.
• Version: integer (int32)
  The version of the attachment.

{
    "type":"object",
    "properties":{
        "CreatedByName":{
            "title":"Uploaded By",
            "type":"string",
            "description":"The name of the user who created the attachment.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Uploaded On",
            "type":"string",
            "description":"The date and time when the attachment was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ConfidentialFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the attachment is a confidential document. The default value is N for no.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "DocumentSubcategory":{
            "title":"Subcategory",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier for the document subcategory.",
            "nullable":true,
            "x-queryable":true
        },
        "PreviewHeight":{
            "type":"number",
            "description":"This column indicates the height of a stored thumbnail.",
            "nullable":true,
            "x-hints":{
                "precision":"8",
                "scale":"2"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"100",
            "type":"string",
            "description":"The description for the file attached.",
            "nullable":true,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The unique identifier of the public sector agency.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "ProjectAttachmentAccessor":{
            "title":"Project Attachment Accessors",
            "type":"array",
            "description":"The project attachment accessor resource is used for displaying file-related information such as file name and file URL.",
            "items":{
                "$ref":"#/components/schemas/publicSectorProjectAttachments-ProjectAttachmentAccessor-item-response"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":"255",
            "type":"string",
            "description":"The name of the file attached.",
            "nullable":false,
            "x-queryable":true
        },
        "DocumentCategory":{
            "title":"Category",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier for the document category.",
            "nullable":true,
            "x-queryable":true
        },
        "AttachmentKey":{
            "type":"integer",
            "description":"The unique identifier for the project attachment row.",
            "nullable":false,
            "x-hints":{
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "Version":{
            "type":"integer",
            "description":"The version of the attachment.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"4"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ProjectCode":{
            "title":"Project ID",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier of the project.",
            "nullable":false,
            "x-queryable":true
        },
        "PreviewWidth":{
            "type":"number",
            "description":"This column indicates the width of a stored thumbnail.",
            "nullable":true,
            "x-hints":{
                "precision":"8",
                "scale":"2"
            },
            "x-queryable":true
        },
        "ProjectAgencyId":{
            "type":"integer",
            "description":"The unique identifier of the public sector agency.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "AttachmentType":{
            "maxLength":"15",
            "type":"string",
            "description":"The attachment type to identify project attachments. The values is PRO.",
            "nullable":true,
            "default":"PRO",
            "x-queryable":true
        },
        "UpdatedByName":{
            "title":"Last Updated By",
            "type":"string",
            "description":"The name of the user who last updated the attachment.",
            "nullable":true,
            "x-queryable":true
        },
        "Preview":{
            "type":"string",
            "description":"This column contains the thumbnail of an attached file.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "AttachmentId":{
            "type":"integer",
            "description":"The unique identifier of the attachment from the common attachment table.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "DocumentGroupId":{
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier for the document group.",
            "nullable":true,
            "x-queryable":true
        },
        "FileType":{
            "maxLength":"100",
            "type":"string",
            "description":"The type of the file attached whether text/plain, image/jpeg and so on.",
            "nullable":true,
            "x-queryable":true
        },
        "RequiredFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the attachment is a required document. The default value is N for no.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "AttachmentEntityName":{
            "maxLength":"255",
            "type":"string",
            "description":"The unique identifier to indicate project attachments(PSC_DOC_PRO) used by the attachment component.",
            "nullable":true,
            "default":"PSC_DOC_PRO",
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the attachment was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FileSize":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the file attached.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ProjectAttachmentId":{
            "type":"integer",
            "description":"The unique identifier of the attachment from the common attachment table.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"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 : Project Attachment Accessors

Type: array

Title: Project Attachment Accessors

The project attachment accessor resource is used for displaying file-related information such as file name and file URL.

Show Source

• Array of: object publicSectorProjectAttachments-ProjectAttachmentAccessor-item-response

{
    "title":"Project Attachment Accessors",
    "type":"array",
    "description":"The project attachment accessor resource is used for displaying file-related information such as file name and file URL.",
    "items":{
        "$ref":"#/components/schemas/publicSectorProjectAttachments-ProjectAttachmentAccessor-item-response"
    }
}

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."
        }
    }
}

Nested Schema : publicSectorProjectAttachments-ProjectAttachmentAccessor-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.
• AttachmentsRevision: array Project Attachment Revisions
  Title: Project Attachment Revisions

  The project attachment revisions resource is used for displaying the historical information for an attachment.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  The unique name given to the project attachment accessors, which makes the attachment functionality work in conjunction with the entity name.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attached file repository is shared. The default value is false.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  The name of the user who created the attachment.
• 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 and time when the attachment was created.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  The data type code of the attachment.
• Description: string
  Title: Description

  Maximum Length: 255

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

  The unique document identifier that is used by the Attachment framework.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  The folder path of the attachment.
• DmVersionNumber: string
  Maximum Length: 255

  The version number used by the Attachment framework.
• 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 code that indicates the error status of the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  The message that describes the error status of the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

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

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

  Maximum Length: 2048

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

  The URL or web address of the attached 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 and time when the attachment was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

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

  Read Only: true

  The user who last updated the attachment.
• 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 such as text/plain, or csv.
• UploadedFileLength: integer
  Title: File Size

  The file length of the attachment in bytes.
• UploadedFileName: string
  Title: Uploaded File Name

  The name of the attached file.
• UploadedText: string
  Title: Uploaded Text

  The text that is entered along with the attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The type of universal resource identifier (URI) associated with the attachment. For example, URL.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL associated with an attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  The user's unique user name for signing in to the fusion system.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the attachment 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 name of the file attached.",
            "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"
            }
        },
        "AttachmentsRevision":{
            "title":"Project Attachment Revisions",
            "type":"array",
            "description":"The project attachment revisions resource is used for displaying the historical information for an attachment.",
            "items":{
                "$ref":"#/components/schemas/publicSectorProjectAttachments-ProjectAttachmentAccessor-AttachmentsRevision-item-response"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":"4000",
            "type":"string",
            "description":"The type of universal resource identifier (URI) associated with the attachment. For example, URL.",
            "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 associated with an attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":"255",
            "type":"string",
            "description":"The unique document identifier that is used by the Attachment framework.",
            "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 such as text/plain, or csv.",
            "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 file length of the attachment in bytes.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"The version number used by the Attachment framework.",
            "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 name of user who last updated the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The message that describes the error status of 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 user's unique user name for signing in to the fusion system.",
            "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 name of the user who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"The data type code of the attachment.",
            "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 who last updated the attachment.",
            "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 of the attached file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URL or web address of the attached 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 attached file repository is shared. The default value is false.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The file contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The date of expiration of the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The code that indicates the error status of 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 of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text that is entered along with the 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 unique name given to the project attachment accessors, which makes the attachment functionality work in conjunction with the entity name.",
            "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 and time when the attachment 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 : Project Attachment Revisions

Type: array

Title: Project Attachment Revisions

The project attachment revisions resource is used for displaying the historical information for an attachment.

Show Source

• Array of: object publicSectorProjectAttachments-ProjectAttachmentAccessor-AttachmentsRevision-item-response

{
    "title":"Project Attachment Revisions",
    "type":"array",
    "description":"The project attachment revisions resource is used for displaying the historical information for an attachment.",
    "items":{
        "$ref":"#/components/schemas/publicSectorProjectAttachments-ProjectAttachmentAccessor-AttachmentsRevision-item-response"
    }
}

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 : publicSectorProjectAttachments-ProjectAttachmentAccessor-AttachmentsRevision-item-response

Type: object

Show Source

• AttachedDocumentId: string
  Read Only: true

  The unique identifier of an attached document.
• ContentId: string
  Maximum Length: 80

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

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

  The link relations associated with the resource instance.
• RevisionId: string
  Maximum Length: 80

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

  The label for an attachment revision.
• UserRevisionId: integer
  The unique identifier for an attachment revision.

{
    "type":"object",
    "properties":{
        "FileUrl":{
            "type":"string",
            "description":"The web address for an attached file.",
            "nullable":true,
            "x-queryable":false
        },
        "ErrorStatusMessage":{
            "type":"string",
            "description":"The message that describes the error status of the attachment.",
            "nullable":true,
            "x-queryable":false
        },
        "AttachedDocumentId":{
            "type":"string",
            "description":"The unique identifier of an attached document.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "InDate":{
            "type":"string",
            "description":"Indicates the date that the file was attached.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "Format":{
            "maxLength":"128",
            "type":"string",
            "description":"The format of the attachment.",
            "nullable":true,
            "x-queryable":true
        },
        "UserRevisionId":{
            "type":"integer",
            "description":"The unique identifier for an attachment revision.",
            "nullable":true,
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "type":"string",
            "description":"The code that indicates the error status of the attachment.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ContentId":{
            "maxLength":"80",
            "type":"string",
            "description":"The unique identifier of the attachment content.",
            "nullable":false,
            "x-queryable":true
        },
        "RevisionId":{
            "maxLength":"80",
            "type":"string",
            "description":"The unique identifier of the attachment revision.",
            "nullable":false,
            "x-queryable":true
        },
        "RevLabel":{
            "maxLength":"80",
            "type":"string",
            "description":"The label for an attachment revision.",
            "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"
    }
}

Links

ProjectAttachmentAccessor

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorProjectAttachments/{AttachmentKey}/child/ProjectAttachmentAccessor

Parameters:

• AttachmentKey: $request.path.AttachmentKey

The project attachment accessor resource is used for displaying file-related information such as file name and file URL.

Back to Top