1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Import Export Objects Metadata

Get all file import and export objects

get

/crmRestApi/resources/11.13.18.05/importExportObjectMetadata

Request

Query Parameters
  • 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:

    • attachmentObjectRowFinder: Finds an object row with the specified key.
      Finder Variables:
      • ObjectCode; string; The language independent code of the object.
    • exportObjectFinder: Finds an export object with the specified key.
      Finder Variables:
      • noteObjectRowFinder: Finds a note object row with the specified key.
        Finder Variables:
        • ObjectCode; string; The language independent code of the object.
      • objectRowFinder: Finds an import export object with a specified object name.
        Finder Variables:
        • ObjectCode; string; The Language Independent Code of the object.
    • 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:
      • CreatedBy; string; The user who created the record.
      • CreationDate; string; The date and time when the record was created.
      • CustomFlag; boolean; Indicates whether the object is a custom object or not.
      • Description; string; The description Of the object.
      • DisplayName; string; The display name of the object.
      • DownloadTemplate; string; The link for downloading the object template.
      • ExportSupport; string; Indicates whether export activity is supported for the object. If the value is Y, then export is supported.
      • ImportSupport; string; Indicates whether import activity is supported for the object. If the value is Y, then import is supported.
      • KeyAttributes; string; The primary key attributes of the object, in a comma separated list.
      • LastUpdateDate; string; The date and time when the record was last updated.
      • LastUpdateLogin; string; The login of the user who last updated the record.
      • LastUpdatedBy; string; The user who last updated the record.
      • ObjectCode; string; The language independent code of the object.
      • ParentKeyAttributes; string; The parent foreign key attributes for the object, in a comma separated list.
      • ParentObjectCode; string; The language independent code of the parent object.
      • PrimaryVoCount; integer; The number of primary view objects for the object.
      • PuidAttribute; string; The public unique identifier of the object.
      • RequiredFields; string; The required attributes of the object.
      • SupportAttachmentImport; string; Indicates whether the attachment import is supported.
      • SupportHighVolume; string; Indicates whether the object supports high volume import.
      • SupportNoteImport; string; Indicates whether the note import is supported.
      • UcmAccount; string; The UCM account where the file can be uploaded.
    • 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 : importExportObjectMetadata
    Type: object
    Show Source
    Nested Schema : Items
    Type: array
    Title: Items
    The items in the collection.
    Show Source
    Nested Schema : importExportObjectMetadata-item-response
    Type: object
    Show Source
    Nested Schema : Import Export Object Attributes
    Type: array
    Title: Import Export Object Attributes
    The import export object attributes resource is used to view the attributes of a specific object which support for file-based import and export.
    Show Source
    Nested Schema : importExportObjectMetadata-ObjectAttributes-item-response
    Type: object
    Show Source
    • Title: Attribute Name
      Maximum Length: 100
      The name of the object attribute.
    • Title: Created By
      Read Only: true
      Maximum Length: 64
      The user who created the record.
    • Title: Creation Date
      Read Only: true
      The date and time when the record was created.
    • Title: Custom Attribute
      Maximum Length: 1
      Default Value: false
      Indicates whether the object attribute is a custom attribute.
    • Title: Description
      The description of the object.
    • Title: Display Name
      The display name of the object.
    • Indicates whether the attribute is available for mapping in import and export.
    • Title: Primary Key
      Maximum Length: 1
      Default Value: false
      Indicates whether the object attribute is part of the object Primary Key.
    • Title: Primary Key Number
      The sequence of the attributes within the composite primary key attributes of the object.
    • Maximum Length: 128
      Indicates the language independent code for the object attribute.
    • Title: Last Update Date
      Read Only: true
      The date and time when the record was last updated.
    • Title: Last Updated By
      Read Only: true
      Maximum Length: 64
      The user who last updated the record.
    • Title: Last Updated
      Read Only: true
      Maximum Length: 32
      The login of the user who last updated the record.
    • Title: Length
      The length of the object attribute.
    • Links
    • Maximum Length: 255
      The name of the object.
    • Title: Primary Parent Key
      Maximum Length: 1
      Default Value: false
      Indicates whether the object attribute is part of the object's Parent Primary Key.
    • Title: Parent Primary Key Number
      The sequence of the attributes within the composite primary key attributes of the object's Parent Primary Key.
    • Title: Parent Primary Alternate Key
      Maximum Length: 1
      Default Value: false
      Indicates whether the object attribute is the parent's PUID attribute.
    • Title: Attribute Precision
      The precision of the object attribute.
    • Title: Primary Alternate Key
      Maximum Length: 1
      Default Value: false
      Indicates whether the object attribute is the PUID attribute.
    • Title: Searchable
      Read Only: true
      Indicates whether the object can be searched by the attribute.
    • Title: Required
      Maximum Length: 1
      Default Value: false
      Indicates whether the object attribute is required.
    • Title: Attribute Scale
      The scale of the object attribute.
    • Title: Type
      Read Only: true
      The data type of the object attribute.
    • Title: Updatable
      Maximum Length: 1
      Default Value: false
      Indicates whether the object attribute is updatable.
    Back to Top

    Examples

    The following example shows how to get all file import and export objects by submitting a GET request on the REST resource using cURL.

    cURL Command

    curl -u <username:password> \ -X POST -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/importExportObjectMetadata

    Example of Response Body

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

    {
 "items" : [ 
	{
    "DisplayName" : "Account",
    "Description" : "An Organization Profile Includes Details About an Organization such as Organization Details, Additional Names, Additional Identifiers, Addresses, and Contact Points. Some Examples of Organizations are Customers, Sales Prospects, Competitors, and Partners.",
    "ObjectCode" : "Account",
    "ParentObjectCode" : null,
    "CustomFlag" : false,
    "SupportHighVolume" : "Y",
    "PuidAttribute" : "PartyNumber",
    "KeyAttributes" : "PartyId",
    "ParentKeyAttributes" : "",
    "RequiredFields" : "Party ID:Party Number:Organization ID:Name:Sales Account Number:Site Number:E-Mail:URL:Registry ID:Country",
    "CreatedBy" : "MHoope",
    "CreationDate" : "2017-10-30T22:58:29+00:00",
    "LastUpdatedBy" : "MHoope",
    "LastUpdateDate" : "2017-10-30T22:58:33.260+00:00",
    "LastUpdateLogin" : "5CCC8D7CD19B420BE053768DF50A9BFD",
    "UcmAccount" : "crm/simplifiedAccount/import/",
    "links" : 
	...
	},
	{
   	"DisplayName" : "Activity Assignee",
    "Description" : "Activity Assignee",
    "ObjectCode" : "ActivityAssignee",
    "ParentObjectCode" : "Activity",
    "CustomFlag" : false,
    "SupportHighVolume" : "N",
    "PuidAttribute" : null,
    "KeyAttributes" : "ActivityIdAssigneeId",
    "ParentKeyAttributes" : "ActivityId",
    "RequiredFields" : "Activity ID:Assignee ID:Activity Number",
    "CreatedBy" : "MHoope",
    "CreationDate" : "2017-10-30T22:58:31.632+00:00",
    "LastUpdatedBy" : "MHoope",
    "LastUpdateDate" : "2017-10-30T22:58:33.812+00:00",
    "LastUpdateLogin" : "5CCC8D7CD19B420BE053768DF50A9BFD",
    "UcmAccount" : null,
    "links" :
	...
	}
	],
  "count": 2,
  "hasMore": false,
  "limit": 25,
  "offset": 0,
  "links": 
  ...
  }
    Back to Top