Get parent folder or smart text
get
/crmRestApi/resources/11.13.18.05/smartTextFolderAndTexts/{UniqueIdentifier}/child/ParentFolderIdStandardTextFolderAndText/{UniqueIdentifier2}
Request
Path Parameters
-
UniqueIdentifier(required): integer(int64)
The unique identifier of the folder or the text. It is the StdTxtId of the smart text or the FolderId of the smart text folder.
-
UniqueIdentifier2(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
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 : smartTextFolderAndTexts-ParentFolderIdStandardTextFolderAndText-item-response
Type:
Show Source
object
-
BuOrgId: number
Read Only:
true
The unique identifier of the business unit for the parent record that primarily uses the Smart Text or folder. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the smart text or smart text folder. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the smart text or smart text folder for the parent record was created. -
Domain: string
Read Only:
true
Maximum Length:240
The domain or category for the folder or text. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The login of the user who last updated the smart text or smart text folder for the parent record. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The date when the smart text or smart text folder for the parent record was last updated. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The user who last updated the smart text or smart text folder for the parent record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Read Only:
true
Maximum Length:50
The name of the smart text or smart text folder. -
Object: string
Read Only:
true
Maximum Length:150
The primary object of the smart text or folder. -
ParentFolderId: integer
(int64)
Title:
Parent ID
Read Only:true
The name of the parent folder for the smart text or smart text folder. -
Scope: string
Read Only:
true
Maximum Length:20
The scope of the smart text or smart text folder. The list of valid values are ORA_SVC_USER and ORA_SVC_GLOBAL. -
StripeCd: string
Read Only:
true
Maximum Length:30
The stripe code for the folder, such as ORA_SVC_CRM. -
Type: string
Read Only:
true
Maximum Length:6
The type of the source record. The valid values are Text and Folder. -
UniqueIdentifier: integer
(int64)
Read Only:
true
The unique identifier of the folder or the text. It is the StdTxtId of the smart text or the FolderId of the smart text folder. -
UniqueNumber: string
Read Only:
true
Maximum Length:30
The primary unique identifier of the Smart Text or folder for the parent record. -
UserPartyId: integer
(int64)
Title:
User ID
Read Only:true
The scope of the smart text or smart text folder. The list of valid values are ORA_SVC_USER and ORA_SVC_GLOBAL.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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.
Links
- ScopeLookup
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_SVC_STDTXT_SCOPE_CD
The list of values indicating the scope of the SmartText or folder. - finder: