Get a file import and export object
get
/crmRestApi/resources/11.13.18.05/importExportObjectMetadata/{ObjectCode}
Request
Path Parameters
-
ObjectCode(required): string
The language independent code of the object.
Query Parameters
-
dependency: string
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> -
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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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 TopResponse
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.
Root Schema : importExportObjectMetadata-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the record was created. -
CustomFlag: boolean
Title:
Custom Object
Maximum Length:1
Default Value:false
Indicates whether the object is a custom object or not. -
Description: string
Title:
Description
The description Of the object. -
DisplayName: string
Title:
Display Name
The display name of the object. -
DownloadTemplate: string
(byte)
Title:
Download
Read Only:true
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
Title:
User Keys
Read Only:true
The primary key attributes of the object, in a comma separated list. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date and time when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Title:
Last Updated
Read Only:true
Maximum Length:32
The login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectAttributes: array
Import Export Object Attributes
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. -
ObjectCode: string
Title:
Object
Maximum Length:128
The language independent code of the object. -
ParentKeyAttributes: string
Title:
Parent Object Key Attributes
Read Only:true
The parent foreign key attributes for the object, in a comma separated list. -
ParentObjectCode: string
Title:
Parent Object
Maximum Length:2000
The language independent code of the parent object. -
PrimaryVoCount: integer
(int32)
The number of primary view objects for the object.
-
PuidAttribute: string
Title:
Primary Alternate Key
Maximum Length:100
The public unique identifier of the object. -
RequiredFields: string
Title:
Required Fields
The required attributes of the object. -
SupportAttachmentImport: string
Read Only:
true
Maximum Length:255
Indicates whether the attachment import is supported. -
SupportHighVolume: string
Title:
Support High Volume
Maximum Length:1
Indicates whether the object supports high volume import. -
SupportNoteImport: string
Read Only:
true
Maximum Length:255
Indicates whether the note import is supported. -
UcmAccount: string
Title:
Account
Maximum Length:120
The UCM account where the file can be uploaded.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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 : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : importExportObjectMetadata-ObjectAttributes-item-response
Type:
Show Source
object
-
AttributeCode: string
Title:
Attribute Name
Maximum Length:100
The name of the object attribute. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the record was created. -
CustomAttributeFlag: boolean
Title:
Custom Attribute
Maximum Length:1
Default Value:false
Indicates whether the object attribute is a custom attribute. -
Description: string
Title:
Description
The description of the object. -
DisplayName: string
Title:
Display Name
The display name of the object. -
ImportExportMappable: string
Indicates whether the attribute is available for mapping in import and export.
-
KeyFlag: boolean
Title:
Primary Key
Maximum Length:1
Default Value:false
Indicates whether the object attribute is part of the object Primary Key. -
KeyNumber: number
Title:
Primary Key Number
The sequence of the attributes within the composite primary key attributes of the object. -
LangIndependentCode: string
Maximum Length:
128
Indicates the language independent code for the object attribute. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date and time when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Title:
Last Updated
Read Only:true
Maximum Length:32
The login of the user who last updated the record. -
Length: number
Title:
Length
The length of the object attribute. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectName: string
Maximum Length:
255
The name of the object. -
ParentKeyFlag: boolean
Title:
Primary Parent Key
Maximum Length:1
Default Value:false
Indicates whether the object attribute is part of the object's Parent Primary Key. -
ParentKeyNumber: number
Title:
Parent Primary Key Number
The sequence of the attributes within the composite primary key attributes of the object's Parent Primary Key. -
ParentPuidFlag: boolean
Title:
Parent Primary Alternate Key
Maximum Length:1
Default Value:false
Indicates whether the object attribute is the parent's PUID attribute. -
Precision: number
Title:
Attribute Precision
The precision of the object attribute. -
PuidFlag: boolean
Title:
Primary Alternate Key
Maximum Length:1
Default Value:false
Indicates whether the object attribute is the PUID attribute. -
QueryableFlag: boolean
Title:
Searchable
Read Only:true
Indicates whether the object can be searched by the attribute. -
RequiredFlag: boolean
Title:
Required
Maximum Length:1
Default Value:false
Indicates whether the object attribute is required. -
Scale: number
Title:
Attribute Scale
The scale of the object attribute. -
Type: string
Title:
Type
Read Only:true
The data type of the object attribute. -
UpdatableFlag: boolean
Title:
Updatable
Maximum Length:1
Default Value:false
Indicates whether the object attribute is updatable.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- ObjectAttributes
-
Operation: /crmRestApi/resources/11.13.18.05/importExportObjectMetadata/{ObjectCode}/child/ObjectAttributesParameters:
- ObjectCode:
$request.path.ObjectCode
The import export object attributes resource is used to view the attributes of a specific object which support for file-based import and export. - ObjectCode:
Examples
The following example shows how to get all file import and export object attributes 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/ActivityObjectives/child/ObjectAttributes
Example of Response Body
The following shows an example of the response body in JSON format.
{ "items" : [ { "DisplayName" : "LastUpdatedBy", "Description" : "", "AttributeCode" : "LastUpdatedBy", "Type" : "String", "Length" : 64, "Scale" : -127, "Precision" : 64, "UpdatableFlag" : false, "RequiredFlag" : true, "CustomAttributeFlag" : false, "PuidFlag" : false, "ParentPuidFlag" : false, "KeyFlag" : false, "KeyNumber" : null, "ParentKeyFlag" : false, "ParentKeyNumber" : null, "CreatedBy" : "MHoope", "CreationDate" : "2017-10-30T22:58:31.805+00:00", "LastUpdatedBy" : "MHoope", "LastUpdateDate" : "2017-10-30T22:58:33.859+00:00", "LastUpdateLogin" : "5CCC8D7CD19B420BE053768DF50A9BFD", "links" : ... }, { "DisplayName" : "LastUpdateLogin", "Description" : "", "AttributeCode" : "LastUpdateLogin", "Type" : "String", "Length" : 32, "Scale" : -127, "Precision" : 32, "UpdatableFlag" : false, "RequiredFlag" : false, "CustomAttributeFlag" : false, "PuidFlag" : false, "ParentPuidFlag" : false, "KeyFlag" : false, "KeyNumber" : null, "ParentKeyFlag" : false, "ParentKeyNumber" : null, "CreatedBy" : "MHoope", "CreationDate" : "2017-10-30T22:58:31.806+00:00", "LastUpdatedBy" : "MHoope", "LastUpdateDate" : "2017-10-30T22:58:33.860+00:00", "LastUpdateLogin" : "5CCC8D7CD19B420BE053768DF50A9BFD", "links" : ... } ], "count": 2, "hasMore": false, "limit": 25, "offset": 0, "links": ... }