Jump to

• Request
• Response

Get all Attachments

get

/crmRestApi/resources/11.13.18.05/autoEvents/{EventNumber}/child/Attachments

Request

Path Parameters

• EventNumber: string
  Identifier to Events

Query Parameters

• dependency: string
  This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the attributes will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency attributes. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource attributes. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• 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 attached document with the specified primary key. Finder Variables:
    • AttachedDocumentId; integer; The unique identifier of the attached document.
• 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.
• 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 attributes. 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
• 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".

Back to Top

Response

Supported Media Types

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

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : autoEvents-Attachments

Type: object

Show Source

• count(optional): integer
  Title: Count

  The attachments resource is used to view, create, update, or delete attachments of an event.
• hasMore(optional): boolean
  Title: HasMore

  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(optional): array Items
  Title: Items

  The items in the collection.
• limit(optional): integer
  Title: Limit

  The actual paging size used by the server.
• links(optional): array Items
  Title: Items

  The link relations associated with the resource instance.
• offset(optional): integer
  Title: Offset

  The offset value used in the current page.

{
    "properties":{
        "count":{
            "type":"integer",
            "description":"The attachments resource is used to view, create, update, or delete attachments of an event.",
            "title":"Count"
        },
        "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.",
            "title":"HasMore"
        },
        "items":{
            "items":{
                "$ref":"#/definitions/autoEvents-Attachments-item"
            },
            "type":"array",
            "description":"The items in the collection.",
            "title":"Items"
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server.",
            "title":"Limit"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "title":"Items"
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page.",
            "title":"Offset"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object autoEvents-Attachments-item

{
    "items":{
        "$ref":"#/definitions/autoEvents-Attachments-item"
    },
    "type":"array",
    "description":"The items in the collection.",
    "title":"Items"
}

Nested Schema : Items

Type: array

Title: Items

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : autoEvents-Attachments-item

Type: object

Show Source

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

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

  The unique identifier of the attachment.
• CategoryName(optional): string
  Title: Category

  Maximum Length: 30

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

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

  Maximum Length: 255

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

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

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

  Maximum Length: 30

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

  Maximum Length: 255

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

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

  Maximum Length: 1000

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

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

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

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

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

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

  Maximum Length: 2048

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

  The URI of the file.
• LastUpdateDate(optional): string(date-time)
  Title: Last Update Date

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

  Maximum Length: 255

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

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

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

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

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

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

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

  The text of the attachment.
• Uri(optional): string
  Title: Uri

  Maximum Length: 4000

  The URI of the attachment.
• Url(optional): string
  Title: Url

  Maximum Length: 4000

  The URL of the attachment.
• UserName(optional): string
  Title: User Name

  Maximum Length: 255

  The login credentials of the user who created the attachment.

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

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

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

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

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

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

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

Back to Top