Jump to

• Request
• Response

Get all permit attachments

get

/fscmRestApi/resources/11.13.18.05/publicSectorPermitAllAttachments

Request

Query Parameters

• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • PrimaryKey: Finds the attachment that matches the primary key criteria specified.
    Finder Variables:
    • AttachmentId; integer; The unique identifier of the attachment.
    • AttachmentKey; integer; The unique key for the attachment.
  • simpleSearchFinder: Finds an attachment using the specified keyword.
    Finder Variables:
    • value; string; The keyword used to find an attachment by description or file name.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • AgencyId; integer; The agency identifier of the public sector entity to which this attachment applies.
  • AttachmentId; integer; The unique identifier for a permit attachment.
  • AttachmentKey; integer; The unique identifier for the attachment.
  • AttachmentType; string; The type of attachment, such as for plan reviews, inspections, workflow, or permits.
  • Attachmententityname; string; The entity name of the attachment.
  • ChecklistId; string; The name that uniquely identifies an inspection checklist.
  • ChecklistItemId; string; The name that uniquely identifies an inspection checklist item.
  • ConfidentialFlag; boolean; Indicates whether the attachment is a confidential document. The default value is N for no.
  • CreatedByName; string; The name of the user who created the attachment.
  • CreationDate; string; The date and time when the attachment was created.
  • Description; string; The description of the attachment.
  • DocCategory; string; The category used for dividing the attached document into a logical group.
  • DocGroupId; string; The document group specified on the permit type when the attachment was uploaded.
  • DocSubcategory; string; The subcategory used for dividing the attached document into a logical group along with the category.
  • DocumentReviewedFlag; string; Indicates whether the attachment was reviewed and returned by the electronic document review application. The default value is N.
  • FileContentUploadedFlag; boolean; Indicates whether the attachment file contents has been successfully uploaded. The default value is N for no. The core attachments API has been restructured for attachments insert functionality. See Document 3034288.1 in My Oracle Support.
  • FileName; string; The name of the attached file.
  • FileSize; integer; The size of the attached file.
  • FileType; string; The file format of the attachment, such as PDF or text.
  • InsAttachmentKey; integer; The unique identifier for the inspection attachment.
  • InsChecklistId; string; The unique identifier of the inspection checklist.
  • InsChklstAgencyId; integer; The unique identifier of the agency associated with the inspection checklist attachment.
  • InschklistDescription; string; The description of an inspection checklist.
  • InspectionId; string; The unique identifier of the inspection.
  • LastUpdateDate; string; The date and time when the attachment was last updated.
  • LastUpdateLogin; string; The login name of the user who last updated the attachment.
  • LnpRecordKey; integer; 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.
  • ObjAgencyId; integer; The agency identifier of the public sector entity to which this attachment applies.
  • ObjAttachmentId; integer; The unique identifier for the attachment.
  • ObjectVersionNumber; integer; The object version number for the attachment.
  • PlanReviewFlag; string; 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.
  • PreviewHeight; number; This column indicates the height of a stored thumbnail.
  • PreviewWidth; number; This column indicates the width of a stored thumbnail.
  • RequiredFlag; boolean; Indicates whether the attachment is a required document. The default value is N for no.
  • RevisedDocUploadedFlag; string; Indicates whether the attachment was uploaded during a rejected or approved plan review cycle. The default value is N for no.
  • SubjectId; string; The subject of the attachment.
  • UpdatedByName; string; The name of the user who last updated the attachment.
  • Version; integer; The version of the attachment.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

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

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

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

Body ()

Root Schema : publicSectorPermitAllAttachments

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/publicSectorPermitAllAttachments-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"Permits",
        "usage":"BusinessObject",
        "group":"psc"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object publicSectorPermitAllAttachments-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/publicSectorPermitAllAttachments-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 : publicSectorPermitAllAttachments-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Read Only: true

  The agency identifier of the public sector entity to which this attachment applies.
• Attachmententityname: string
  Read Only: true

  Maximum Length: 11

  The entity name of the attachment.
• AttachmentId: integer
  The unique identifier for a permit attachment.
• AttachmentKey: integer
  The unique identifier for the attachment.
• AttachmentType: string
  Read Only: true

  Maximum Length: 15

  The type of attachment, such as for plan reviews, inspections, workflow, or permits.
• ChecklistId: string
  Read Only: true

  Maximum Length: 15

  The name that uniquely identifies an inspection checklist.
• ChecklistItemId: string
  Read Only: true

  Maximum Length: 15

  The name that uniquely identifies an inspection checklist item.
• ConfidentialFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates whether the attachment is a confidential document. The default value is N for no.
• CreatedByName: string
  The name of the user who created the attachment.
• CreationDate: string (date-time)
  Read Only: true

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

  Read Only: true

  Maximum Length: 100

  The description of the attachment.
• DocCategory: string
  Read Only: true

  Maximum Length: 30

  The category used for dividing the attached document into a logical group.
• DocGroupId: string
  Read Only: true

  Maximum Length: 30

  The document group specified on the permit type when the attachment was uploaded.
• DocSubcategory: string
  Read Only: true

  Maximum Length: 30

  The subcategory used for dividing the attached document into a logical group along with the category.
• DocumentReviewedFlag: string
  Read Only: true

  Maximum Length: 1

  Indicates whether the attachment was reviewed and returned by the electronic document review application. The default value is N.
• FileContentUploadedFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates whether the attachment file contents has been successfully uploaded. The default value is N for no. The core attachments API has been restructured for attachments insert functionality. See Document 3034288.1 in My Oracle Support.
• FileName: string
  Title: File Name

  Read Only: true

  Maximum Length: 255

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

  Read Only: true

  The size of the attached file.
• FileType: string
  Read Only: true

  Maximum Length: 100

  The file format of the attachment, such as PDF or text.
• InsAttachmentKey: integer
  Read Only: true

  The unique identifier for the inspection attachment.
• InsChecklistId: string
  Read Only: true

  Maximum Length: 60

  The unique identifier of the inspection checklist.
• InschklistDescription: string
  Read Only: true

  Maximum Length: 400

  The description of an inspection checklist.
• InsChklstAgencyId: integer
  Read Only: true

  The unique identifier of the agency associated with the inspection checklist attachment.
• InspectionId: string
  Read Only: true

  Maximum Length: 50

  The unique identifier of the inspection.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the attachment was last updated.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login name of the user who last updated the attachment.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LnpAllAttachmentAccessor: array All Permit Attachment Accessors
  Title: All Permit Attachment Accessors

  The all permit attachment accessors resource is used for displaying attachment file-related information such as file name and file URL.
• LnpRecordKey: integer (int64)
  Read Only: true

  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.
• ObjAgencyId: integer
  Read Only: true

  The agency identifier of the public sector entity to which this attachment applies.
• ObjAttachmentId: integer (int64)
  Read Only: true

  The unique identifier for the attachment.
• ObjectVersionNumber: integer (int32)
  Read Only: true

  The object version number for the attachment.
• PlanReviewFlag: string
  Read Only: true

  Maximum Length: 1

  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)
  Read Only: true

  This column contains the thumbnail of an attached file.
• PreviewHeight: number
  Read Only: true

  This column indicates the height of a stored thumbnail.
• PreviewWidth: number
  Read Only: true

  This column indicates the width of a stored thumbnail.
• RequiredFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates whether the attachment is a required document. The default value is N for no.
• RevisedDocUploadedFlag: string
  Read Only: true

  Maximum Length: 1

  Indicates whether the attachment was uploaded during a rejected or approved plan review cycle. The default value is N for no.
• SubjectId: string
  Read Only: true

  Maximum Length: 30

  The subject of the attachment.
• UpdatedByName: string
  The name of the user who last updated the attachment.
• Version: integer (int32)
  Read Only: true

  The version of the attachment.

{
    "type":"object",
    "properties":{
        "CreatedByName":{
            "type":"string",
            "description":"The name of the user who created the attachment.",
            "nullable":true,
            "x-queryable":true
        },
        "LnpAllAttachmentAccessor":{
            "title":"All Permit Attachment Accessors",
            "type":"array",
            "description":"The all permit attachment accessors resource is used for displaying attachment file-related information such as file name and file URL.",
            "items":{
                "$ref":"#/components/schemas/publicSectorPermitAllAttachments-LnpAllAttachmentAccessor-item-response"
            }
        },
        "ConfidentialFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the attachment is a confidential document. The default value is N for no.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the attachment was created.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InsAttachmentKey":{
            "type":"integer",
            "description":"The unique identifier for the inspection attachment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PreviewHeight":{
            "type":"number",
            "description":"This column indicates the height of a stored thumbnail.",
            "nullable":true,
            "readOnly":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,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The agency identifier of the public sector entity to which this attachment applies.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "FileName":{
            "title":"File Name",
            "maxLength":"255",
            "type":"string",
            "description":"The name of the attached file.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChecklistId":{
            "maxLength":"15",
            "type":"string",
            "description":"The name that uniquely identifies an inspection checklist.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InsChecklistId":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier of the inspection checklist.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AttachmentKey":{
            "type":"integer",
            "description":"The unique identifier for the attachment.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number for the attachment.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "Version":{
            "type":"integer",
            "description":"The version of the attachment.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"4"
            },
            "x-queryable":true
        },
        "ChecklistItemId":{
            "maxLength":"15",
            "type":"string",
            "description":"The name that uniquely identifies an inspection checklist item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ObjAgencyId":{
            "type":"integer",
            "description":"The agency identifier of the public sector entity to which this attachment applies.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubjectId":{
            "maxLength":"30",
            "type":"string",
            "description":"The subject of the attachment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DocCategory":{
            "maxLength":"30",
            "type":"string",
            "description":"The category used for dividing the attached document into a logical group.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DocSubcategory":{
            "maxLength":"30",
            "type":"string",
            "description":"The subcategory used for dividing the attached document into a logical group along with the category.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InsChklstAgencyId":{
            "type":"integer",
            "description":"The unique identifier of the agency associated with the inspection checklist attachment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PreviewWidth":{
            "type":"number",
            "description":"This column indicates the width of a stored thumbnail.",
            "nullable":true,
            "readOnly":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, workflow, or permits.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UpdatedByName":{
            "type":"string",
            "description":"The name of the user who last updated the attachment.",
            "nullable":true,
            "x-queryable":true
        },
        "RevisedDocUploadedFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the attachment was uploaded during a rejected or approved plan review cycle. The default value is N for no.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InspectionId":{
            "maxLength":"50",
            "type":"string",
            "description":"The unique identifier of the inspection.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Preview":{
            "type":"string",
            "description":"This column contains the thumbnail of an attached file.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "FileContentUploadedFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the attachment file contents has been successfully uploaded. The default value is N for no. The core attachments API has been restructured for attachments insert functionality. See Document 3034288.1 in My Oracle Support.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "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":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AttachmentId":{
            "type":"integer",
            "description":"The unique identifier for a permit attachment.",
            "nullable":true,
            "x-queryable":true
        },
        "FileType":{
            "maxLength":"100",
            "type":"string",
            "description":"The file format of the attachment, such as PDF or text.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DocumentReviewedFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the attachment was reviewed and returned by the electronic document review application. The default value is N.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequiredFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the attachment is a required document. The default value is N for no.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DocGroupId":{
            "maxLength":"30",
            "type":"string",
            "description":"The document group specified on the permit type when the attachment was uploaded.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjAttachmentId":{
            "type":"integer",
            "description":"The unique identifier for the attachment.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PlanReviewFlag":{
            "maxLength":"1",
            "type":"string",
            "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":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Attachmententityname":{
            "maxLength":"11",
            "type":"string",
            "description":"The entity name of the attachment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InschklistDescription":{
            "maxLength":"400",
            "type":"string",
            "description":"The description of an inspection checklist.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FileSize":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attached file.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "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":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The login name of the user who last updated the attachment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : All Permit Attachment Accessors

Type: array

Title: All Permit Attachment Accessors

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

Show Source

• Array of: object publicSectorPermitAllAttachments-LnpAllAttachmentAccessor-item-response

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

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

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

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

  The all permit attachment 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 unique identifier for an attachment.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

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

  The version for an attachment.
• 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 core attachments API has been restructured and this attribute is no longer supported for attachments insert functionality. Use these attributes instead: UploadedFileContentType, UploadedFileLength, and UploadedFileName. See Document 3034288.1 in My Oracle Support.
• 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.
• PostProcessingAction: string
  Title: PostProcessingAction

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

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

  The content type of the attachment, such as text/plain or csv. The core attachments API has been restructured and this attribute is now required for attachments insert functionality. See Document 3034288.1 in My Oracle Support.
• UploadedFileLength: integer
  Title: File Size

  The file length of the attachment in bytes. The core attachments API has been restructured and this attribute is now required for attachments insert functionality. See Document 3034288.1 in My Oracle Support.
• UploadedFileName: string
  Title: Uploaded File Name

  The name of the attached file. The core attachments API has been restructured and this attribute is now required for attachments insert functionality. See Document 3034288.1 in My Oracle Support.
• UploadedText: string
  Title: Uploaded Text

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

  Maximum Length: 4000

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

  Maximum Length: 4000

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

  Read Only: true

  Maximum Length: 255

  The user's unique user name for 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":"All Permit Attachment Revisions",
            "type":"array",
            "description":"The all permit attachment revisions resource is used for displaying the historical information for a permit attachment.",
            "items":{
                "$ref":"#/components/schemas/publicSectorPermitAllAttachments-LnpAllAttachmentAccessor-AttachmentsRevision-item-response"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":"4000",
            "type":"string",
            "description":"The type of universal resource identifier (URI) associated with the attachment. For example, URL.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":"4000",
            "type":"string",
            "description":"The URL associated with an attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":"255",
            "type":"string",
            "description":"The unique identifier for an attachment.",
            "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 text/plain or csv. The core attachments API has been restructured and this attribute is now required for attachments insert functionality. See Document 3034288.1 in My Oracle Support.",
            "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. The core attachments API has been restructured and this attribute is now required for attachments insert functionality. See Document 3034288.1 in My Oracle Support.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"The version for an attachment.",
            "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"
            }
        },
        "UserName":{
            "title":"User Name",
            "maxLength":"255",
            "type":"string",
            "description":"The user's unique user name for logging into the system.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"255",
            "type":"string",
            "description":"The user who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"The datatype code of the attachment.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"The user who last updated the attachment.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name of the attached file. The core attachments API has been restructured and this attribute is now required for attachments insert functionality. See Document 3034288.1 in My Oracle Support.",
            "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 core attachments API has been restructured and this attribute is no longer supported for attachments insert functionality. Use these attributes instead: UploadedFileContentType, UploadedFileLength, and UploadedFileName. See Document 3034288.1 in My Oracle Support.",
            "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 the exclusive use by the Attachment UI components to assist in uploading files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

Nested Schema : All Permit Attachment Revisions

Type: array

Title: All Permit Attachment Revisions

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

Show Source

• Array of: object publicSectorPermitAllAttachments-LnpAllAttachmentAccessor-AttachmentsRevision-item-response

{
    "title":"All Permit Attachment Revisions",
    "type":"array",
    "description":"The all permit attachment revisions resource is used for displaying the historical information for a permit attachment.",
    "items":{
        "$ref":"#/components/schemas/publicSectorPermitAllAttachments-LnpAllAttachmentAccessor-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 : publicSectorPermitAllAttachments-LnpAllAttachmentAccessor-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"
    }
}

Back to Top