1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Service Requests
  4. Service Requests 11.13.18.05
  5. Attachments

Get all attachments

get

/crmRestApi/resources/11.13.18.05/serviceRequests/{SrNumber}/child/Attachment

Request

Path Parameters
  • The unique number that is used to identify a service request. You can configure the service request number to a format that is best suitable to your organizational requirements. For example, service request may have the formats service request0000012345, service request_000_12345, 12345_00_service request, and so on depending on your requirements.
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields 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 fields 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 fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • 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).
  • 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
  • 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.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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:
    • AttachedDocumentId; integer; The unique identifier of the attached document.
    • CategoryName; string; The name of the attachment category.
    • CreatedBy; string; The user who created the attachment.
    • CreatedByUserName; string; The user name of the person who uploaded the image.
    • CreationDate; string; The date when the attachment record was created.
    • DatatypeCode; string; The code indicating the type of the data.
    • DmDocumentId; string; The unique identifier of the attached document.
    • DmFolderPath; string; The folder path of the attachment.
    • DmVersionNumber; string; The current version number of the attachment.
    • ExpirationDate; string; The date when the contents in the attachment expire.
    • FileName; string; The file name of the attachment.
    • LastUpdateDate; string; The date when the record was last updated.
    • LastUpdatedBy; string; The user who last updated the attachment.
    • LastUpdatedByUserName; string; The user name of the person who last updated the image.
    • Uri; string; The URI of the attachment.
    • Url; string; The URL of the attachment.
    • UserName; string; The login associated with the attachment.
  • 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
  • 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".
  • 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

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : serviceRequests-Attachment
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : serviceRequests-Attachment-item-response
Type: object
Show Source
Nested Schema : AttachmentsDFFVL
Type: array
Show Source
Nested Schema : Attachments Preview
Type: array
Title: Attachments Preview
The attachments preview resource is used to preview the attachment pages.
Show Source
Nested Schema : serviceRequests-Attachment-AttachmentsDFFVL-item-response
Type: object
Show Source
Nested Schema : serviceRequests-Attachment-AttachmentsPreview-item-response
Type: object
Show Source
Back to Top

Examples

The following example shows how to get information on all attachments by submitting a GET request on the REST resource.

Example of Request Header

The following shows an example of the request header.

GET /crmRestApi/resources/11.13.18.05/serviceRequests/SR0000066002/child/Attachment

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 200 OK
Date: Mon, 19 Sep 2016 10:39:38 GMT
Server: Oracle-HTTP-Server-11g
Content-Type: application/vnd.oracle.adf.resourceitem+json
Content-Language: en

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
  "items": [
    {
      "LastUpdateDate": "2016-09-13T15:38:13-07:00",
      "LastUpdatedBy": "SALES_ADMIN",
      "DatatypeCode": "WEB_PAGE",
      "FileName": null,
      "DmFolderPath": null,
      "Url": "http://www.oracle.com",
      "CategoryName": "MISC",
      "UserName": "Miscellaneous",
      "Uri": null,
      "FileUrl": null,
      "UploadedText": null,
      "UploadedFileContentType": null,
      "UploadedFileLength": null,
      "UploadedFileName": null,
      "ContentRepositoryFileShared": "false",
      "Title": "http://www.oracle.com",
      "Description": "",
      "ErrorStatusCode": null,
      "ErrorStatusMessage": null,
      "CreatedBy": "SALES_ADMIN",
      "CreationDate": "2016-09-13T15:37:36-07:00",
      "ExpirationDate": null,
      "links": [
        {
          "rel": "self",
          "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000066002/child/Attachment/00020000000EACED00057708000110F07F66E0BD0000000EACED00057708000110F07F66E0BC",
          "name": "Attachment",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000066002/child/Attachment/00020000000EACED00057708000110F07F66E0BD0000000EACED00057708000110F07F66E0BC",
          "name": "Attachment",
          "kind": "item"
        },
        {
          "rel": "parent",
          "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000066002",
          "name": "serviceRequests",
          "kind": "item"
        },
        {
          "rel": "enclosure",
          "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000066002/child/Attachment/00020000000EACED00057708000110F07F66E0BD0000000EACED00057708000110F07F66E0BC/enclosure/FileContents",
          "name": "FileContents",
          "kind": "other"
        }
      ]
    },

. . .

  "count": 2,
  "hasMore": false,
  "limit": 25,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/serviceRequests/SR0000066002/child/Attachment",
      "name": "Attachment",
      "kind": "collection"
    }
  ]
}
Back to Top