Update a smart text folder
patch
/crmRestApi/resources/11.13.18.05/smartTextFolders/{FolderId}
Request
Path Parameters
-
FolderId(required): integer(int64)
The unique identifier of the smart text folder.
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
BuOrgId: integer
(int64)
The unique identifier of the business unit organization for the folder.
-
Domain: string
Maximum Length:
30
The domain or category for the child folder. -
FolderNumber: string
Maximum Length:
30
This is a public unique identifier of the child folder. -
Name: string
Title:
Name
Maximum Length:50
The description of the child folder. -
ParentFolderId: integer
(int64)
Title:
Parent ID
The parent folder identifier used to identify parents of a sub-folder. -
SmartTextChildFolders: array
Smart Text Child Folders
Title:
Smart Text Child Folders
The smart text child folder resource is used to view, create, delete, and update the smart text child folders. -
StripeCd: string
Maximum Length:
30
The stripe code for the folder, such as ORA_SVC_CRM. -
UserPartyId: integer
(int64)
Title:
User ID
The unique identifier of the user to whom the smart text folder belongs to. If no value is provided, then the folder is a global standard folder.
Nested Schema : Smart Text Child Folders
Type:
array
Title:
Smart Text Child Folders
The smart text child folder resource is used to view, create, delete, and update the smart text child folders.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
BuOrgId: integer
(int64)
The unique identifier of the business unit organization for the folder.
-
Domain: string
Maximum Length:
30
The domain or category for the child folder. -
FolderNumber: string
Maximum Length:
30
This is a public unique identifier of the child folder. -
Name: string
Title:
Name
Maximum Length:50
The description of the child folder. -
ParentFolderId: integer
(int64)
Title:
Parent ID
The parent folder identifier used to identify parents of a sub-folder. -
StripeCd: string
Maximum Length:
30
The stripe code for the folder, such as ORA_SVC_CRM. -
UserPartyId: integer
(int64)
Title:
User ID
The unique identifier of the user to whom the smart text folder belongs to. If no value is provided, then the folder is a global standard folder.
Response
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 : smartTextFolders-item-response
Type:
Show Source
object
-
BuOrgId: integer
(int64)
The unique identifier of the business unit organization for the folder.
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the smart text folder. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the smart text folder was created. -
Domain: string
Maximum Length:
30
The domain or category for the child folder. -
FolderId: integer
(int64)
Title:
Folder ID
Read Only:true
The unique identifier of the smart text folder. -
FolderNumber: string
Maximum Length:
30
This is a public unique identifier of the child folder. -
FolderUniqueNumber: string
Maximum Length:
30
The public unique identifier of the child folder. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the smart text folder was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the smart text folder. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the smart text folder. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Name
Maximum Length:50
The description of the child folder. -
ParentBuOrgId: integer
(int64)
Read Only:
true
The unique identifier of the business unit organization for the parent folder. -
ParentFolderId: integer
(int64)
Title:
Parent ID
The parent folder identifier used to identify parents of a sub-folder. -
ParentFolderName: string
Title:
Name
Read Only:true
Maximum Length:50
The description of the parent folder. -
ParentFolderUniqueNumber: string
Maximum Length:
30
The public unique identifier of the parent folder. -
PartyNumber: string
Read Only:
true
Maximum Length:30
The public unique identifier of the user associated to this folder. -
SmartTextChildFolders: array
Smart Text Child Folders
Title:
Smart Text Child Folders
The smart text child folder resource is used to view, create, delete, and update the smart text child folders. -
StripeCd: string
Maximum Length:
30
The stripe code for the folder, such as ORA_SVC_CRM. -
UserPartyId: integer
(int64)
Title:
User ID
The unique identifier of the user to whom the smart text folder belongs to. If no value is provided, then the folder is a global standard folder.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Smart Text Child Folders
Type:
array
Title:
Smart Text Child Folders
The smart text child folder resource is used to view, create, delete, and update the smart text child folders.
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 : smartTextFolders-SmartTextChildFolders-item-response
Type:
Show Source
object
-
BuOrgId: integer
(int64)
The unique identifier of the business unit organization for the folder.
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the smart text folder. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the smart text folder was created. -
Domain: string
Maximum Length:
30
The domain or category for the child folder. -
FolderId: integer
(int64)
Title:
Folder ID
Read Only:true
The unique identifier of the smart text folder. -
FolderNumber: string
Maximum Length:
30
This is a public unique identifier of the child folder. -
FolderUniqueNumber: string
Maximum Length:
30
The public unique identifier of the child folder. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the smart text folder was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the smart text folder. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the smart text folder. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Name
Maximum Length:50
The description of the child folder. -
ParentBuOrgId: integer
(int64)
Read Only:
true
The unique identifier of the business unit organization for the parent folder. -
ParentFolderId: integer
(int64)
Title:
Parent ID
The parent folder identifier used to identify parents of a sub-folder. -
ParentFolderName: string
Title:
Name
Read Only:true
Maximum Length:50
The description of the parent folder. -
ParentFolderUniqueNumber: string
Maximum Length:
30
The public unique identifier of the parent folder. -
PartyNumber: string
Read Only:
true
Maximum Length:30
The public unique identifier of the user associated to this folder. -
StripeCd: string
Maximum Length:
30
The stripe code for the folder, such as ORA_SVC_CRM. -
UserPartyId: integer
(int64)
Title:
User ID
The unique identifier of the user to whom the smart text folder belongs to. If no value is provided, then the folder is a global standard folder.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- SmartTextChildFolders
-
Operation: /crmRestApi/resources/11.13.18.05/smartTextFolders/{FolderId}/child/SmartTextChildFoldersParameters:
- FolderId:
$request.path.FolderId
The smart text child folder resource is used to view, create, delete, and update the smart text child folders. - FolderId: