Jump to

• Request
• Response

Create an attachment for a permit

post

/fscmRestApi/resources/11.13.18.05/publicSectorRecordAttachments

Request

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 ()

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

Root Schema : schema

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  The agency identifier of the public sector entity to which this attachment applies.
• AttachmentEntityName: string
  Maximum Length: 255

  Default Value: PSC_DOC_LNP

  The entity name of the attachment.
• AttachmentId: integer (int64)
  The unique identifier for a permit attachment.
• AttachmentType: string
  Maximum Length: 15

  Default Value: LNP

  The type of attachment, such as for plan reviews, inspections, or permits.
• CreatedByName: string
  Title: Uploaded By

  The user who created the attachment.
• Description: string
  Title: Description

  Maximum Length: 100

  The description of the attachment.
• DigitalSignatureFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates whether the attachment requires a digital signature. If the value is Y, then a digital signature is required. The default value is N.
• DocumentCategory: string
  Title: Category

  Maximum Length: 30

  The category used for dividing the attached document into a logical group.
• DocumentGroupId: string
  Maximum Length: 30

  The document group specified on the permit type when the attachment was uploaded.
• DocumentReviewedFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates whether the attachment was reviewed and returned by the electronic document review application. The default value is N.
• DocumentSubcategory: string
  Title: Subcategory

  Maximum Length: 30

  The subcategory used for dividing the attached document into a logical group along with the category.
• FileName(required): string
  Title: File Name

  Maximum Length: 255

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

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

  The file type of attachment, such as PDF or text.
• FinalDocumentFlag: boolean
  Title: Final

  Maximum Length: 1

  Default Value: false

  Indicates whether the attachment is the final document for a permit, business license, or planning application. The default value is N for no.
• LnpAttachmentAccessor: array Record Attachment Accessors
  Title: Record Attachment Accessors

  The record attachment accessors resource is used for displaying permit attachment file-related information such as file name and file URL.
• LnpAttachmentKey: integer (int64)
  The unique key associated with the permit attachment.
• LnpAttachmentPuid(required): string
  Maximum Length: 480

  The public unique identifier for a permit attachment.
• LnpRecordKey(required): integer (int64)
  The unique identifier for a record. The record is for a permit, business license, professional license, or planning and zoning, and is determined by the classification.
• PlanReviewFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates whether the attachment is associated with a plan review. If the value is Y, then the attachment is associated with a plan review. The default value is N.
• 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.
• RecordAgencyId(required): integer (int32)
  The agency identifier of the public sector entity to which this attachment applies.
• RecordAttachmentId(required): integer (int64)
  The unique identifier for an attachment.
• RecordNumber(required): string
  Maximum Length: 64

  The public unique identifier for a permit record.
• RevisedDocUploadedFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates whether the attachment was uploaded during a rejected or approved plan review cycle. Default value is N for no.
• SubjectId: string
  Maximum Length: 30

  The subject of the attachment.
• UpdatedByName: string
  Title: Last Updated By

  The user who last updated the attachment.
• Version(required): integer (int32)
  The version of the attachment.
• WriteProtectedFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates whether the attachment is write-protected. The default value is N for no.

{
    "required":[
        "FileName",
        "FileSize",
        "LnpAttachmentPuid",
        "LnpRecordKey",
        "RecordAgencyId",
        "RecordAttachmentId",
        "RecordNumber",
        "Version"
    ],
    "type":"object",
    "properties":{
        "CreatedByName":{
            "title":"Uploaded By",
            "type":"string",
            "description":"The user who created the attachment.",
            "nullable":true
        },
        "DocumentSubcategory":{
            "title":"Subcategory",
            "maxLength":30,
            "type":"string",
            "description":"The subcategory used for dividing the attached document into a logical group along with the category.",
            "nullable":true
        },
        "PreviewHeight":{
            "type":"number",
            "description":"This column indicates the height of a stored thumbnail.",
            "nullable":true,
            "x-hints":{
                "precision":8,
                "scale":2
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":100,
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The agency identifier of the public sector entity to which this attachment applies.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":255,
            "type":"string",
            "description":"The name of the attached file.",
            "nullable":false
        },
        "LnpAttachmentPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier for a permit attachment.",
            "nullable":false
        },
        "FinalDocumentFlag":{
            "title":"Final",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the attachment is the final document for a permit, business license, or planning application. The default value is N for no.",
            "nullable":false,
            "default":false
        },
        "DocumentCategory":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The category used for dividing the attached document into a logical group.",
            "nullable":true
        },
        "Version":{
            "type":"integer",
            "description":"The version of the attachment.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":4
            }
        },
        "SubjectId":{
            "maxLength":30,
            "type":"string",
            "description":"The subject of the attachment.",
            "nullable":true
        },
        "RecordAttachmentId":{
            "type":"integer",
            "description":"The unique identifier for an attachment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "WriteProtectedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the attachment is write-protected. The default value is N for no.",
            "nullable":false,
            "default":false
        },
        "LnpAttachmentKey":{
            "type":"integer",
            "description":"The unique key associated with the permit attachment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "PreviewWidth":{
            "type":"number",
            "description":"This column indicates the width of a stored thumbnail.",
            "nullable":true,
            "x-hints":{
                "precision":8,
                "scale":2
            }
        },
        "AttachmentType":{
            "maxLength":15,
            "type":"string",
            "description":"The type of attachment, such as for plan reviews, inspections, or permits.",
            "nullable":true,
            "default":"LNP"
        },
        "UpdatedByName":{
            "title":"Last Updated By",
            "type":"string",
            "description":"The user who last updated the attachment.",
            "nullable":true
        },
        "RevisedDocUploadedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the attachment was uploaded during a rejected or approved plan review cycle. Default value is N for no.",
            "nullable":false,
            "default":false
        },
        "Preview":{
            "type":"string",
            "description":"This column contains the thumbnail of an attached file.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "LnpRecordKey":{
            "type":"integer",
            "description":"The unique identifier for a record. The record is for a permit, business license, professional license, or planning and zoning, and is determined by the classification.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "LnpAttachmentAccessor":{
            "title":"Record Attachment Accessors",
            "type":"array",
            "description":"The record attachment accessors resource is used for displaying permit attachment file-related information such as file name and file URL.",
            "items":{
                "$ref":"#/components/schemas/publicSectorRecordAttachments-LnpAttachmentAccessor-item-post-request"
            }
        },
        "AttachmentId":{
            "type":"integer",
            "description":"The unique identifier for a permit attachment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "DocumentGroupId":{
            "maxLength":30,
            "type":"string",
            "description":"The document group specified on the permit type when the attachment was uploaded.",
            "nullable":true
        },
        "DigitalSignatureFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the attachment requires a digital signature. If the value is Y, then a digital signature is required. The default value is N.",
            "nullable":false,
            "default":false
        },
        "FileType":{
            "maxLength":100,
            "type":"string",
            "description":"The file type of attachment, such as PDF or text.",
            "nullable":true
        },
        "DocumentReviewedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the attachment was reviewed and returned by the electronic document review application. The default value is N.",
            "nullable":false,
            "default":false
        },
        "PlanReviewFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the attachment is associated with a plan review. If the value is Y, then the attachment is associated with a plan review. The default value is N.",
            "nullable":false,
            "default":false
        },
        "RecordNumber":{
            "maxLength":64,
            "type":"string",
            "description":"The public unique identifier for a permit record.",
            "nullable":false
        },
        "RecordAgencyId":{
            "type":"integer",
            "description":"The agency identifier of the public sector entity to which this attachment applies.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":8
            }
        },
        "AttachmentEntityName":{
            "maxLength":255,
            "type":"string",
            "description":"The entity name of the attachment.",
            "nullable":true,
            "default":"PSC_DOC_LNP"
        },
        "FileSize":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attached file.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

Nested Schema : Record Attachment Accessors

Type: array

Title: Record Attachment Accessors

The record attachment accessors resource is used for displaying permit attachment file-related information such as file name and file URL.

Show Source

• Array of: object publicSectorRecordAttachments-LnpAttachmentAccessor-item-post-request

{
    "title":"Record Attachment Accessors",
    "type":"array",
    "description":"The record attachment accessors resource is used for displaying permit attachment file-related information such as file name and file URL.",
    "items":{
        "$ref":"#/components/schemas/publicSectorRecordAttachments-LnpAttachmentAccessor-item-post-request"
    }
}

Nested Schema : publicSectorRecordAttachments-LnpAttachmentAccessor-item-post-request

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

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

  The unique identifier for an attachment.
• AttachmentsRevision: array Record Attachment Revisions
  Title: Record Attachment Revisions

  The record attachments revisions resource is used for displaying the historical information for a permit attachment.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  The unique name given to the permit attachment file-related information, 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.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  The datatype code of the attachment.
• 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 of the attachment file.
• DmVersionNumber: string
  Maximum Length: 255

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

  The 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 attached file.
• FileUrl: string
  Title: File Url

  The URL or web address of the attached file.
• Title: string
  Title: Title

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

  The content type of the attachment such as plain text or comma-separated value format.
• 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(required): string
  Title: User Name

  Maximum Length: 255

  The user's unique user name for logging into the system.

{
    "required":[
        "UserName"
    ],
    "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 name of the attached file.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "AttachmentsRevision":{
            "title":"Record Attachment Revisions",
            "type":"array",
            "description":"The record attachments revisions resource is used for displaying the historical information for a permit attachment.",
            "items":{
                "$ref":"#/components/schemas/publicSectorRecordAttachments-LnpAttachmentAccessor-AttachmentsRevision-item-post-request"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "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 for an attachment.",
            "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 such as plain text or comma-separated value format.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"The 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 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 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 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 logging into the system.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The datatype code of the attachment.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "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 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
            }
        },
        "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 file.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"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 permit attachment file-related information, which makes the attachment functionality work in conjunction with the entity name.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"The attribute provided for 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 : Record Attachment Revisions

Type: array

Title: Record Attachment Revisions

The record attachments revisions resource is used for displaying the historical information for a permit attachment.

Show Source

• Array of: object publicSectorRecordAttachments-LnpAttachmentAccessor-AttachmentsRevision-item-post-request

{
    "title":"Record Attachment Revisions",
    "type":"array",
    "description":"The record attachments revisions resource is used for displaying the historical information for a permit attachment.",
    "items":{
        "$ref":"#/components/schemas/publicSectorRecordAttachments-LnpAttachmentAccessor-AttachmentsRevision-item-post-request"
    }
}

Nested Schema : publicSectorRecordAttachments-LnpAttachmentAccessor-AttachmentsRevision-item-post-request

Type: object

Show Source

• 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)
  The date when the file was attached.
• 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
        },
        "InDate":{
            "type":"string",
            "description":"The date when the file was attached.",
            "format":"date-time",
            "nullable":true
        },
        "Format":{
            "maxLength":128,
            "type":"string",
            "description":"The format of the attachment.",
            "nullable":true
        },
        "UserRevisionId":{
            "type":"integer",
            "description":"The unique identifier for an attachment revision.",
            "nullable":true
        },
        "ErrorStatusCode":{
            "type":"string",
            "description":"The code that indicates the error status of the attachment.",
            "nullable":true,
            "x-queryable":false
        },
        "ContentId":{
            "maxLength":80,
            "type":"string",
            "description":"The unique identifier of the attachment content.",
            "nullable":false
        },
        "RevisionId":{
            "maxLength":80,
            "type":"string",
            "description":"The unique identifier of the attachment revision.",
            "nullable":false
        },
        "RevLabel":{
            "maxLength":80,
            "type":"string",
            "description":"The label for an attachment revision.",
            "nullable":true
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

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

Body ()

Root Schema : publicSectorRecordAttachments-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  The agency identifier of the public sector entity to which this attachment applies.
• AttachmentEntityName: string
  Maximum Length: 255

  Default Value: PSC_DOC_LNP

  The entity name of the attachment.
• AttachmentId: integer (int64)
  The unique identifier for a permit attachment.
• AttachmentType: string
  Maximum Length: 15

  Default Value: LNP

  The type of attachment, such as for plan reviews, inspections, or permits.
• CreatedByName: string
  Title: Uploaded By

  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 of the attachment.
• DigitalSignatureFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates whether the attachment requires a digital signature. If the value is Y, then a digital signature is required. The default value is N.
• DocumentCategory: string
  Title: Category

  Maximum Length: 30

  The category used for dividing the attached document into a logical group.
• DocumentGroupId: string
  Maximum Length: 30

  The document group specified on the permit type when the attachment was uploaded.
• DocumentReviewedFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates whether the attachment was reviewed and returned by the electronic document review application. The default value is N.
• DocumentSubcategory: string
  Title: Subcategory

  Maximum Length: 30

  The subcategory used for dividing the attached document into a logical group along with the category.
• FileName: string
  Title: File Name

  Maximum Length: 255

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

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

  The file type of attachment, such as PDF or text.
• FinalDocumentFlag: boolean
  Title: Final

  Maximum Length: 1

  Default Value: false

  Indicates whether the attachment is the final document for a permit, business license, or planning application. The default value is N for no.
• 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.
• LnpAttachmentAccessor: array Record Attachment Accessors
  Title: Record Attachment Accessors

  The record attachment accessors resource is used for displaying permit attachment file-related information such as file name and file URL.
• LnpAttachmentKey: integer (int64)
  The unique key associated with the permit attachment.
• LnpAttachmentPuid: string
  Maximum Length: 480

  The public unique identifier for a permit attachment.
• LnpRecordKey: integer (int64)
  The unique identifier for a record. The record is for a permit, business license, professional license, or planning and zoning, and is determined by the classification.
• PlanReviewFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates whether the attachment is associated with a plan review. If the value is Y, then the attachment is associated with a plan review. The default value is N.
• 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.
• RecordAgencyId: integer (int32)
  The agency identifier of the public sector entity to which this attachment applies.
• RecordAttachmentId: integer (int64)
  The unique identifier for an attachment.
• RecordNumber: string
  Maximum Length: 64

  The public unique identifier for a permit record.
• RevisedDocUploadedFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates whether the attachment was uploaded during a rejected or approved plan review cycle. Default value is N for no.
• SubjectId: string
  Maximum Length: 30

  The subject of the attachment.
• UpdatedByName: string
  Title: Last Updated By

  The user who last updated the attachment.
• Version: integer (int32)
  The version of the attachment.
• WriteProtectedFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates whether the attachment is write-protected. The default value is N for no.

{
    "type":"object",
    "properties":{
        "CreatedByName":{
            "title":"Uploaded By",
            "type":"string",
            "description":"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
        },
        "DocumentSubcategory":{
            "title":"Subcategory",
            "maxLength":30,
            "type":"string",
            "description":"The subcategory used for dividing the attached document into a logical group along with the category.",
            "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 of the attachment.",
            "nullable":true,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The agency identifier of the public sector entity to which this attachment applies.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "FileName":{
            "title":"File Name",
            "maxLength":255,
            "type":"string",
            "description":"The name of the attached file.",
            "nullable":false,
            "x-queryable":true
        },
        "LnpAttachmentPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier for a permit attachment.",
            "nullable":false,
            "x-queryable":true
        },
        "FinalDocumentFlag":{
            "title":"Final",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the attachment is the final document for a permit, business license, or planning application. The default value is N for no.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "DocumentCategory":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The category used for dividing the attached document into a logical group.",
            "nullable":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"
            }
        },
        "SubjectId":{
            "maxLength":30,
            "type":"string",
            "description":"The subject of the attachment.",
            "nullable":true,
            "x-queryable":true
        },
        "RecordAttachmentId":{
            "type":"integer",
            "description":"The unique identifier for an attachment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "WriteProtectedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the attachment is write-protected. The default value is N for no.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "LnpAttachmentKey":{
            "type":"integer",
            "description":"The unique key associated with the permit attachment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "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
        },
        "AttachmentType":{
            "maxLength":15,
            "type":"string",
            "description":"The type of attachment, such as for plan reviews, inspections, or permits.",
            "nullable":true,
            "default":"LNP",
            "x-queryable":true
        },
        "UpdatedByName":{
            "title":"Last Updated By",
            "type":"string",
            "description":"The user who last updated the attachment.",
            "nullable":true,
            "x-queryable":true
        },
        "RevisedDocUploadedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the attachment was uploaded during a rejected or approved plan review cycle. Default value is N for no.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "Preview":{
            "type":"string",
            "description":"This column contains the thumbnail of an attached file.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "LnpRecordKey":{
            "type":"integer",
            "description":"The unique identifier for a record. The record is for a permit, business license, professional license, or planning and zoning, and is determined by the classification.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LnpAttachmentAccessor":{
            "title":"Record Attachment Accessors",
            "type":"array",
            "description":"The record attachment accessors resource is used for displaying permit attachment file-related information such as file name and file URL.",
            "items":{
                "$ref":"#/components/schemas/publicSectorRecordAttachments-LnpAttachmentAccessor-item-response"
            }
        },
        "AttachmentId":{
            "type":"integer",
            "description":"The unique identifier for a permit attachment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "DocumentGroupId":{
            "maxLength":30,
            "type":"string",
            "description":"The document group specified on the permit type when the attachment was uploaded.",
            "nullable":true,
            "x-queryable":true
        },
        "DigitalSignatureFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the attachment requires a digital signature. If the value is Y, then a digital signature is required. The default value is N.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "FileType":{
            "maxLength":100,
            "type":"string",
            "description":"The file type of attachment, such as PDF or text.",
            "nullable":true,
            "x-queryable":true
        },
        "DocumentReviewedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the attachment was reviewed and returned by the electronic document review application. The default value is N.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "PlanReviewFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the attachment is associated with a plan review. If the value is Y, then the attachment is associated with a plan review. The default value is N.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "RecordNumber":{
            "maxLength":64,
            "type":"string",
            "description":"The public unique identifier for a permit record.",
            "nullable":false,
            "x-queryable":true
        },
        "RecordAgencyId":{
            "type":"integer",
            "description":"The agency identifier of the public sector entity to which this attachment applies.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "AttachmentEntityName":{
            "maxLength":255,
            "type":"string",
            "description":"The entity name of the attachment.",
            "nullable":true,
            "default":"PSC_DOC_LNP",
            "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 attached file.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "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 : Record Attachment Accessors

Type: array

Title: Record Attachment Accessors

The record attachment accessors resource is used for displaying permit attachment file-related information such as file name and file URL.

Show Source

• Array of: object publicSectorRecordAttachments-LnpAttachmentAccessor-item-response

{
    "title":"Record Attachment Accessors",
    "type":"array",
    "description":"The record attachment accessors resource is used for displaying permit attachment file-related information such as file name and file URL.",
    "items":{
        "$ref":"#/components/schemas/publicSectorRecordAttachments-LnpAttachmentAccessor-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 : publicSectorRecordAttachments-LnpAttachmentAccessor-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

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

  The unique identifier for an attachment.
• AttachmentsRevision: array Record Attachment Revisions
  Title: Record Attachment Revisions

  The record attachments revisions resource is used for displaying the historical information for a permit attachment.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  The unique name given to the permit attachment file-related information, 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 user who created the attachment.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

  The user who created the attachment.
• 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 datatype code of the attachment.
• 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 of the attachment file.
• DmVersionNumber: string
  Maximum Length: 255

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

  The 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 attached file.
• 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 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.
• Title: string
  Title: Title

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

  The content type of the attachment such as plain text or comma-separated value format.
• 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

  Maximum Length: 255

  The user's unique user name for logging into the 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 attached file.",
            "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":"Record Attachment Revisions",
            "type":"array",
            "description":"The record attachments revisions resource is used for displaying the historical information for a permit attachment.",
            "items":{
                "$ref":"#/components/schemas/publicSectorRecordAttachments-LnpAttachmentAccessor-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 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 for an attachment.",
            "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 plain text or comma-separated value format.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"The 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 who created the attachment.",
            "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 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 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"
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"The user who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "UserName":{
            "title":"User Name",
            "maxLength":255,
            "type":"string",
            "description":"The user's unique user name for logging into the system.",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The datatype code of the attachment.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "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 file.",
            "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 permit attachment file-related information, 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":"The attribute provided for 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 : Record Attachment Revisions

Type: array

Title: Record Attachment Revisions

The record attachments revisions resource is used for displaying the historical information for a permit attachment.

Show Source

• Array of: object publicSectorRecordAttachments-LnpAttachmentAccessor-AttachmentsRevision-item-response

{
    "title":"Record Attachment Revisions",
    "type":"array",
    "description":"The record attachments revisions resource is used for displaying the historical information for a permit attachment.",
    "items":{
        "$ref":"#/components/schemas/publicSectorRecordAttachments-LnpAttachmentAccessor-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 : publicSectorRecordAttachments-LnpAttachmentAccessor-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)
  The date when 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":"The date when 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

LnpAttachmentAccessor

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorRecordAttachments/{LnpAttachmentKey}/child/LnpAttachmentAccessor

Parameters:

• LnpAttachmentKey: $request.path.LnpAttachmentKey

The record attachment accessors resource is used for displaying permit attachment file-related information such as file name and file URL.

Back to Top