Jump to

• Request
• Response

Get all usage event export queues

get

/crmRestApi/resources/11.13.18.05/usageEventExportQueues

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
  
  

  • ExportQueueNumberAltKey Alternate unique identifier of usage event export queue.
    Finder Variables
    • ExportQueueNumber; string; Export queue number of the usage event export queue.
  • PrimaryKey Primary unique identifier of usage event export queue.
    Finder Variables
    • ExportQueueId; integer; Export queue identifier of the usage event export queue.
  • getRowsByOperationCode Finds the usage event export queues with the operation code.
    Finder Variables
    • bindOperationCode; string; Finder variable of operation code.
    • bindSubmittedByPartyId; integer; Finder variable of submitted By Party Identifier.
• 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:
  

  • BatchId; integer; Unique batch identifier associated with the export.
  • BatchNumber; string; Alternate unique batch identifier associated with the export.
  • CreationDate; string; The date when usage event export queue was first created.
  • ExportName; string; The export name of the export.
  • ExportQueueId; integer; Primary unique identifier of usage event export queue.
  • ExportQueueNumber; string; Alternate unique identifier of usage event export queue.
  • LastUpdateDate; string; The date when usage event export queue was last updated.
  • MappingNumber; integer; Identifier of the columns mapping.
  • ObjectCode; string; Object Code for which CSV contains data.
  • OperationCode; string; The operation code to distinguish between import or export.
  • StatusMeaning; string; The status meaning of export or import.
  • SubmittedByPartyId; integer; The party identifier of the user who submitted the export.
  • UcmContentId; string; The UCM content identifier of the import.
• 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: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

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

Body ()

Root Schema : usageEventExportQueues

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":{
        "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."
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/usageEventExportQueues-item-response"
            }
        },
        "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"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"OEC"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object usageEventExportQueues-item-response

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

Type: object

Show Source

• Attachment: array Attachments
  Title: Attachments

  The attachments resource is used to view, create, and update attachments.
• BatchId: integer (int64)
  Title: Batch ID

  Unique batch identifier associated with the export.
• BatchNumber: string
  Title: Batch

  Maximum Length: 120

  Alternate unique batch identifier associated with the export.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the usage event export queue.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when usage event export queue was first created.
• DateFormat: string
  Title: Date Format

  Default Value: ORA_ZCA_US_FORMAT

  The date format used for the usage event export queue record.
• DecimalSeparator: string
  Title: Decimal Separator

  Default Value: .

  The decimal formal used for the usage event queue record.
• EnableCustomBusinessLogic: string
  Title: Enable Custom Business Logic

  Default Value: YES

  Indicates whether import will have Custom Business Logic enabled or not.
• EnableHighVolumeImportFlag: boolean
  Title: Enable High-volume Import

  Indicates if import will go through high-volume import layer or standard import.
• EnableRoundTrip: string
  Title: Enable Round Trip

  Default Value: NO

  Indicates whether export will have Round Trip enabled or not.
• EnableSplit: string
  Title: Enable Split

  Default Value: NO

  Indicates whether export will have Split enabled or not.
• ErrorReportFileURL: string
  Title: Error File URL

  Maximum Length: 255

  The downloadable URL for the error file in case of error.
• EscapeSpecialCharactersFlag: boolean
  Title: Escape Special Characters

  Indicates whether export will have Special Characters escaped or not.
• ExportCriteria: string
  Title: Export Criteria

  Maximum Length: 1000

  The export criteria for the export done.
• ExportFileURL: string
  Title: Export File URL

  Maximum Length: 255

  The downloadable URL for the export.
• ExportName: string
  Title: Name

  Maximum Length: 120

  The export name of the export.
• ExportQueueId: integer (int64)
  Primary unique identifier of usage event export queue.
• ExportQueueNumber: string
  Title: Export Queue Number

  Maximum Length: 120

  Alternate unique identifier of usage event export queue.
• FileDelimiter: string
  Title: Delimiter

  Default Value: COMMA_DELIMITER

  Delimiter for the import or export file.
• FileEncoding: string
  Title: File Encoding

  Default Value: ORA_ZCA_UTF8_ENCODING

  File encoding format selected.
• ImportMode: string
  Title: Import Mode

  Default Value: CREATE_RECORD

  The mode of import.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when usage event export queue was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the usage event export queue.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MappingNumber: integer (int64)
  Title: Import Mapping

  Identifier of the columns mapping.
• NotificationEmail: string
  Title: Notification Email

  The administrator who should be notified once usage event import or export is completed.
• NotificationRestEndpoint: string
  Title: Notification Endpoint

  Specifies the REST Resource name to which the notification will be sent after the completion of job.
• ObjectCode: string
  Title: Object

  Maximum Length: 32

  Default Value: ORA_OSS_USAGE_EVENTS

  Object Code for which CSV contains data.
• OperationCode: string
  Title: Job Type Code

  Maximum Length: 32

  Default Value: ORA_OSS_EXPORT_TYPE

  The operation code to distinguish between import or export.
• ScheduleStartTime: string (date-time)
  Title: Start Time

  Schedule future timestamp for a scheduled activity job.
• ScheduleType: string
  Title: Schedule Type

  Default Value: ONE_TIME_IMMEDIATE

  Determines whether the job executes immediately or at a future date.
• SplitSize: integer (int64)
  Title: Split Size

  Default Value: 100000

  Size of the export split if enabled.
• StatusCode: string
  Title: Status

  Maximum Length: 255

  The status code for the export.
• StatusMeaning: string
  Title: Status

  Maximum Length: 255

  The status meaning of export or import.
• SubmissionStatus: string
  Title: Submission Status

  Maximum Length: 32

  Default Value: DRAFT

  The submission status of import.
• SubmittedByPartyId: integer (int64)
  Title: Submitted By

  Read Only: true

  The party identifier of the user who submitted the export.
• TimestampFormat: string
  Title: Time Stamp Format

  Default Value: ORA_ZCA_US_FORMAT

  Format of the timestamp values in the file.
• UcmContentId: string
  Title: UCM Content ID

  Maximum Length: 255

  The UCM content identifier of the import.

{
    "type":"object",
    "properties":{
        "Attachment":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/usageEventExportQueues-Attachment-item-response"
            }
        },
        "BatchId":{
            "title":"Batch ID",
            "type":"integer",
            "description":"Unique batch identifier associated with the export.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BatchNumber":{
            "title":"Batch",
            "maxLength":120,
            "type":"string",
            "description":"Alternate unique batch identifier associated with the export.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the usage event export queue.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when usage event export queue was first created.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DateFormat":{
            "title":"Date Format",
            "type":"string",
            "description":"The date format used for the usage event export queue record.",
            "nullable":true,
            "default":"ORA_ZCA_US_FORMAT",
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DecimalSeparator":{
            "title":"Decimal Separator",
            "type":"string",
            "description":"The decimal formal used for the usage event queue record.",
            "nullable":true,
            "default":".",
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EnableCustomBusinessLogic":{
            "title":"Enable Custom Business Logic",
            "type":"string",
            "description":"Indicates whether import will have Custom Business Logic enabled or not.",
            "nullable":true,
            "default":"YES",
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EnableHighVolumeImportFlag":{
            "title":"Enable High-volume Import",
            "type":"boolean",
            "description":"Indicates if import will go through high-volume import layer or standard import.",
            "nullable":true,
            "x-queryable":false
        },
        "EnableRoundTrip":{
            "title":"Enable Round Trip",
            "type":"string",
            "description":"Indicates whether export will have Round Trip enabled or not.",
            "nullable":true,
            "default":"NO",
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EnableSplit":{
            "title":"Enable Split",
            "type":"string",
            "description":"Indicates whether export will have Split enabled or not.",
            "nullable":true,
            "default":"NO",
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ErrorReportFileURL":{
            "title":"Error File URL",
            "maxLength":255,
            "type":"string",
            "description":"The downloadable URL for the error file in case of error.",
            "nullable":true,
            "x-queryable":false
        },
        "EscapeSpecialCharactersFlag":{
            "title":"Escape Special Characters",
            "type":"boolean",
            "description":"Indicates whether export will have Special Characters escaped or not.",
            "nullable":true,
            "x-queryable":false
        },
        "ExportCriteria":{
            "title":"Export Criteria",
            "maxLength":1000,
            "type":"string",
            "description":"The export criteria for the export done.",
            "nullable":true,
            "x-queryable":false
        },
        "ExportFileURL":{
            "title":"Export File URL",
            "maxLength":255,
            "type":"string",
            "description":"The downloadable URL for the export.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "StatusCode"
                ]
            }
        },
        "ExportName":{
            "title":"Name",
            "maxLength":120,
            "type":"string",
            "description":"The export name of the export.",
            "nullable":false,
            "x-queryable":true
        },
        "ExportQueueId":{
            "type":"integer",
            "description":"Primary unique identifier of usage event export queue.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ExportQueueNumber":{
            "title":"Export Queue Number",
            "maxLength":120,
            "type":"string",
            "description":"Alternate unique identifier of usage event export queue.",
            "nullable":false,
            "x-queryable":true
        },
        "FileDelimiter":{
            "title":"Delimiter",
            "type":"string",
            "description":"Delimiter for the import or export file.",
            "nullable":true,
            "default":"COMMA_DELIMITER",
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "FileEncoding":{
            "title":"File Encoding",
            "type":"string",
            "description":"File encoding format selected.",
            "nullable":true,
            "default":"ORA_ZCA_UTF8_ENCODING",
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ImportMode":{
            "title":"Import Mode",
            "type":"string",
            "description":"The mode of import.",
            "nullable":true,
            "default":"CREATE_RECORD",
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when usage event export queue was last updated.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the usage event export queue.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "MappingNumber":{
            "title":"Import Mapping",
            "type":"integer",
            "description":"Identifier of the columns mapping.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18,
                "dependencies":[
                    "ObjectCode"
                ]
            },
            "x-queryable":true
        },
        "NotificationEmail":{
            "title":"Notification Email",
            "type":"string",
            "description":"The administrator who should be notified once usage event import or export is completed.",
            "nullable":true,
            "x-queryable":false
        },
        "NotificationRestEndpoint":{
            "title":"Notification Endpoint",
            "type":"string",
            "description":"Specifies the REST Resource name to which the notification will be sent after the completion of job.",
            "nullable":true,
            "x-queryable":false
        },
        "ObjectCode":{
            "title":"Object",
            "maxLength":32,
            "type":"string",
            "description":"Object Code for which CSV contains data.",
            "nullable":true,
            "default":"ORA_OSS_USAGE_EVENTS",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OperationCode":{
            "title":"Job Type Code",
            "maxLength":32,
            "type":"string",
            "description":"The operation code to distinguish between import or export.",
            "nullable":false,
            "default":"ORA_OSS_EXPORT_TYPE",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ScheduleStartTime":{
            "title":"Start Time",
            "type":"string",
            "description":"Schedule future timestamp for a scheduled activity job.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "ScheduleType":{
            "title":"Schedule Type",
            "type":"string",
            "description":"Determines whether the job executes immediately or at a future date.",
            "nullable":true,
            "default":"ONE_TIME_IMMEDIATE",
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SplitSize":{
            "title":"Split Size",
            "type":"integer",
            "description":"Size of the export split if enabled.",
            "format":"int64",
            "nullable":true,
            "default":100000,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "StatusCode":{
            "title":"Status",
            "maxLength":255,
            "type":"string",
            "description":"The status code for the export.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "StatusMeaning":{
            "title":"Status",
            "maxLength":255,
            "type":"string",
            "description":"The status meaning of export or import.",
            "nullable":true,
            "x-queryable":true
        },
        "SubmissionStatus":{
            "title":"Submission Status",
            "maxLength":32,
            "type":"string",
            "description":"The submission status of import.",
            "nullable":true,
            "default":"DRAFT",
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "SubmittedByPartyId":{
            "title":"Submitted By",
            "type":"integer",
            "description":"The party identifier of the user who submitted the export.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TimestampFormat":{
            "title":"Time Stamp Format",
            "type":"string",
            "description":"Format of the timestamp values in the file.",
            "nullable":true,
            "default":"ORA_ZCA_US_FORMAT",
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "UcmContentId":{
            "title":"UCM Content ID",
            "maxLength":255,
            "type":"string",
            "description":"The UCM content identifier of the import.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The attachments resource is used to view, create, and update attachments.

Show Source

• Array of: object usageEventExportQueues-Attachment-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, and update attachments.",
    "items":{
        "$ref":"#/components/schemas/usageEventExportQueues-Attachment-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 : usageEventExportQueues-Attachment-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

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

  The unique identifier of the attached document.
• CategoryName: string
  Title: Category

  Maximum Length: 30

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

  Indicates whether the attachment is shared
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

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

  Read Only: true

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

  Read Only: true

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

  Maximum Length: 30

  Default Value: FILE

  A value that indicates the data type.
• Description: string
  Title: Description

  Maximum Length: 255

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

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

  Maximum Length: 1000

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

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

  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

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

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

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

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

  Maximum Length: 2048

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

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

  Read Only: true

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

  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

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

  Read Only: true

  The user name who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PostProcessingAction: string
  Title: PostProcessingAction

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

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

  The content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

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

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

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

  Maximum Length: 4000

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

  Maximum Length: 4000

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

  Read Only: true

  Maximum Length: 255

  The login credentials of the user who created the attachment.

{
    "type":"object",
    "properties":{
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The unique identifier of the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"The user name who created the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"A value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "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"
            }
        },
        "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
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "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
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "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":{
                "help":{
                    "instruction":"The base64 encoded image of the file displayed in .png format if the source is a convertible image."
                },
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"The user name who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "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"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"The URI of a Topology Manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"The URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UserName":{
            "title":"User Name",
            "maxLength":255,
            "type":"string",
            "description":"The login credentials of the user who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

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

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top