Jump to

• Request
• Response

Get a code enforcement inspection attachment

get

/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementInspectionAttachments/{publicSectorCodeEnforcementInspectionAttachmentsUniqID}

Request

Path Parameters

• publicSectorCodeEnforcementInspectionAttachmentsUniqID: integer
  This is the hash key of the attributes which make up the composite key--- AttachmentId and AttachmentKey ---for the Code Enforcement Inspection Attachments resource and used to uniquely identify an instance of Code Enforcement Inspection Attachments. The client should not generate the hash key value. Instead, the client should query on the Code Enforcement Inspection Attachments collection resource with a filter on the primary key values in order to navigate to a specific instance of Code Enforcement Inspection Attachments.
  
  For example: publicSectorCodeEnforcementInspectionAttachments?q=AttachmentId=<value1>;AttachmentKey=<value2>

Query Parameters

• dependency: string
  This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes 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 attributes 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 attributes. 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 attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes 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 attributes. 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
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Back to Top

Response

Supported Media Types

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

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorCodeEnforcementInspectionAttachments-item

Type: object

Discriminator: AttachmentType

Show Source

• AgencyId(optional): integer(int32)
  Title: Agency ID

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

  The name of the inspection attachment that is used by the attachment component.
• AttachmentId(optional): integer(int64)
  The unique identifier of the attachment from the common attachment table.
• AttachmentKey(optional): integer(int64)
  The unique identifier of the inspection attachment row.
• AttachmentPuid(optional): string
  Maximum Length: 480

  The legacy system attachment identifier for the migrated data.
• AttachmentType: string
  Maximum Length: 15

  The identifier of the type of attachment.
• CreatedByName(optional): string
  Title: Uploaded By

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

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

  Maximum Length: 100

  The description for the attached file.
• DocCategory(optional): string
  Maximum Length: 30

  The unique identifier of the document category.
• DocSubcategory(optional): string
  Maximum Length: 30

  The unique identifier of the document subcategory.
• FileName(optional): string
  Title: File Name

  Maximum Length: 255

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

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

  The type of the file attached such as, Text, Image, and so on.
• InspectionAttachmentId(optional): integer(int64)
  The unique identifier of the attachment from the common attachment table.
• InspectionAttachmentViewAccessor(optional): array Code Enforcement Inspection Attachment Accessors
  Title: Code Enforcement Inspection Attachment Accessors

  The code enforcement inspection attachment accessors resource is used to display file-related information such as the file name and the file URL.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date and time when the attachment was last updated.
• links(optional): array Items
  Title: Items

  Link Relations
• TransactionKey(optional): integer(int64)
  The unique identifier of the inspection.
• TransactionPuid(optional): string
  Maximum Length: 480

  The legacy system inspection transaction identifier for the migrated data.
• UpdatedByName(optional): string
  Title: Last Updated By

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

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the public sector agency.",
            "title":"Agency ID"
        },
        "AttachmentEntityName":{
            "maxLength":255,
            "type":"string",
            "description":"The name of the inspection attachment that is used by the attachment component."
        },
        "AttachmentId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the attachment from the common attachment table."
        },
        "AttachmentKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the inspection attachment row."
        },
        "AttachmentPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The legacy system attachment identifier for the migrated data."
        },
        "AttachmentType":{
            "maxLength":15,
            "type":"string",
            "description":"The identifier of the type of attachment."
        },
        "CreatedByName":{
            "type":"string",
            "description":"The name of the user who created the attachment.",
            "title":"Uploaded By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the attachment was created.",
            "title":"Uploaded On"
        },
        "Description":{
            "maxLength":100,
            "type":"string",
            "description":"The description for the attached file.",
            "title":"Description"
        },
        "DocCategory":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the document category."
        },
        "DocSubcategory":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the document subcategory."
        },
        "FileName":{
            "maxLength":255,
            "type":"string",
            "description":"The name of the attached file.",
            "title":"File Name"
        },
        "FileSize":{
            "format":"int64",
            "type":"integer",
            "description":"The size of the attached file.",
            "title":"File Size"
        },
        "FileType":{
            "maxLength":100,
            "type":"string",
            "description":"The type of the file attached such as, Text, Image, and so on."
        },
        "InspectionAttachmentId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the attachment from the common attachment table."
        },
        "InspectionAttachmentViewAccessor":{
            "items":{
                "$ref":"#/definitions/publicSectorCodeEnforcementInspectionAttachments-InspectionAttachmentViewAccessor-item"
            },
            "type":"array",
            "description":"The code enforcement inspection attachment accessors resource is used to display file-related information such as the file name and the file URL.",
            "title":"Code Enforcement Inspection Attachment Accessors"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the attachment was last updated.",
            "title":"Last Updated Date"
        },
        "TransactionKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the inspection."
        },
        "TransactionPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The legacy system inspection transaction identifier for the migrated data."
        },
        "UpdatedByName":{
            "type":"string",
            "description":"The name of the user who last updated the attachment.",
            "title":"Last Updated By"
        },
        "Version":{
            "format":"int32",
            "type":"integer",
            "description":"The version of the attachment."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "required":[
        "AttachmentType"
    ],
    "discriminator":"AttachmentType",
    "type":"object"
}

Nested Schema : Code Enforcement Inspection Attachment Accessors

Type: array

Title: Code Enforcement Inspection Attachment Accessors

The code enforcement inspection attachment accessors resource is used to display file-related information such as the file name and the file URL.

Show Source

• Array of: object publicSectorCodeEnforcementInspectionAttachments-InspectionAttachmentViewAccessor-item

{
    "items":{
        "$ref":"#/definitions/publicSectorCodeEnforcementInspectionAttachments-InspectionAttachmentViewAccessor-item"
    },
    "type":"array",
    "description":"The code enforcement inspection attachment accessors resource is used to display file-related information such as the file name and the file URL.",
    "title":"Code Enforcement Inspection Attachment Accessors"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : publicSectorCodeEnforcementInspectionAttachments-InspectionAttachmentViewAccessor-item

Type: object

Show Source

• AsyncTrackerId(optional): string
  Title: Asynchronous Upload Tracker Id

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

  The unique identifier of the attached document.
• AttachmentsRevision(optional): array Code Enforcement Inspection Attachment Revisions
  Title: Code Enforcement Inspection Attachment Revisions

  The code enforcement inspection attachment revisions resource is used to display the historical information about an attachment.
• CategoryName(optional): string
  Title: Category

  Maximum Length: 30

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

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

  Maximum Length: 255

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

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

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

  Maximum Length: 30

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

  Maximum Length: 255

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

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

  Maximum Length: 1000

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

  The document version number from which the attachment is created.
• ErrorStatusCode(optional): string
  Title: Error Status Code

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

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

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

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

  Maximum Length: 2048

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

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

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

  The date and time when the attachment was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 255

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

  The user name who last updated the record.
• links(optional): array Items
  Title: Items

  Link Relations
• Title(optional): string
  Title: Title

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

  The content type of the attachment.
• UploadedFileLength(optional): integer(int64)
  Title: File Size

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

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

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

  Maximum Length: 4000

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

  Maximum Length: 4000

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

  Maximum Length: 255

  The login credentials of the user who created the attachment.

{
    "properties":{
        "AsyncTrackerId":{
            "type":"string",
            "description":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "title":"Asynchronous Upload Tracker Id"
        },
        "AttachedDocumentId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the attached document.",
            "title":"Attached Document Id"
        },
        "AttachmentsRevision":{
            "items":{
                "$ref":"#/definitions/publicSectorCodeEnforcementInspectionAttachments-InspectionAttachmentViewAccessor-AttachmentsRevision-item"
            },
            "type":"array",
            "description":"The code enforcement inspection attachment revisions resource is used to display the historical information about an attachment.",
            "title":"Code Enforcement Inspection Attachment Revisions"
        },
        "CategoryName":{
            "maxLength":30,
            "type":"string",
            "description":"The category of the attachment.",
            "title":"Category"
        },
        "ContentRepositoryFileShared":{
            "type":"boolean",
            "description":"Indicates whether the attachment is shared.",
            "title":"Shared"
        },
        "CreatedBy":{
            "maxLength":255,
            "type":"string",
            "description":"The user who created the record.",
            "title":"Created By"
        },
        "CreatedByUserName":{
            "type":"string",
            "description":"The user name who created the record.",
            "title":"Created By User Name"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the record was created.",
            "title":"Creation Date"
        },
        "DatatypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"The data type code of the attachment.",
            "title":"Type"
        },
        "Description":{
            "maxLength":255,
            "type":"string",
            "description":"The description of the attachment.",
            "title":"Description"
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"The document ID from which the attachment is created."
        },
        "DmFolderPath":{
            "maxLength":1000,
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "title":"Dm Folder Path"
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The document version number from which the attachment is created."
        },
        "ErrorStatusCode":{
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "title":"Error Status Code"
        },
        "ErrorStatusMessage":{
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "title":"Error Status Message"
        },
        "ExpirationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "title":"Expiration Date"
        },
        "FileContents":{
            "format":"binary",
            "type":"string",
            "description":"The contents of the attachment.",
            "title":"File Contents"
        },
        "FileName":{
            "maxLength":2048,
            "type":"string",
            "description":"The file name of the attachment.",
            "title":"File Name"
        },
        "FileUrl":{
            "type":"string",
            "description":"The URI of the file.",
            "title":"File Url"
        },
        "FileWebImage":{
            "format":"binary",
            "type":"string",
            "description":"The base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "title":"File Web Image"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the attachment was last updated.",
            "title":"Last Update Date"
        },
        "LastUpdatedBy":{
            "maxLength":255,
            "type":"string",
            "description":"The name of the user who last updated the attachment.",
            "title":"Last Updated By"
        },
        "LastUpdatedByUserName":{
            "type":"string",
            "description":"The user name who last updated the record.",
            "title":"Last Updated By User"
        },
        "Title":{
            "type":"string",
            "description":"The title of the attachment.",
            "title":"Title"
        },
        "UploadedFileContentType":{
            "type":"string",
            "description":"The content type of the attachment.",
            "title":"Uploaded File Content Type"
        },
        "UploadedFileLength":{
            "format":"int64",
            "type":"integer",
            "description":"The size of the attachment file.",
            "title":"File Size"
        },
        "UploadedFileName":{
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "title":"Uploaded File Name"
        },
        "UploadedText":{
            "type":"string",
            "description":"The text content for a new text attachment.",
            "title":"Uploaded Text"
        },
        "Uri":{
            "maxLength":4000,
            "type":"string",
            "description":"The URI of a Topology Manager type attachment.",
            "title":"Uri"
        },
        "Url":{
            "maxLength":4000,
            "type":"string",
            "description":"The URL of a web page type attachment.",
            "title":"Url"
        },
        "UserName":{
            "maxLength":255,
            "type":"string",
            "description":"The login credentials of the user who created the attachment.",
            "title":"User Name"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Code Enforcement Inspection Attachment Revisions

Type: array

Title: Code Enforcement Inspection Attachment Revisions

The code enforcement inspection attachment revisions resource is used to display the historical information about an attachment.

Show Source

• Array of: object publicSectorCodeEnforcementInspectionAttachments-InspectionAttachmentViewAccessor-AttachmentsRevision-item

{
    "items":{
        "$ref":"#/definitions/publicSectorCodeEnforcementInspectionAttachments-InspectionAttachmentViewAccessor-AttachmentsRevision-item"
    },
    "type":"array",
    "description":"The code enforcement inspection attachment revisions resource is used to display the historical information about an attachment.",
    "title":"Code Enforcement Inspection Attachment Revisions"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : publicSectorCodeEnforcementInspectionAttachments-InspectionAttachmentViewAccessor-AttachmentsRevision-item

Type: object

Show Source

• AttachedDocumentId(optional): integer(int64)
  The unique identifier of the attached document for this revision.
• ErrorStatusCode(optional): string
  The error code, if any, for the attachment revision.
• ErrorStatusMessage(optional): string
  The error message, if any, for the attachment revision.
• FileUrl(optional): string
  The file name of the attachment revision.
• links(optional): array Items
  Title: Items

  Link Relations

{
    "properties":{
        "AttachedDocumentId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the attached document for this revision."
        },
        "ErrorStatusCode":{
            "type":"string",
            "description":"The error code, if any, for the attachment revision."
        },
        "ErrorStatusMessage":{
            "type":"string",
            "description":"The error message, if any, for the attachment revision."
        },
        "FileUrl":{
            "type":"string",
            "description":"The file name of the attachment revision."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top