Jump to

• Request
• Response

Update a SmartText child folder

patch

/crmRestApi/resources/11.13.18.05/smartTextFolders/{FolderId}/child/SmartTextChildFolders/{FolderId2}

Request

Path Parameters

• FolderId(required): integer(int64)
  The unique identifier of the smart text folder.
• FolderId2(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=

Header Parameters

• Metadata-Context: string
  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: string
  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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "BuOrgId":{
            "type":"integer",
            "description":"The unique identifier of the business unit organization for the folder.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "Domain":{
            "maxLength":30,
            "type":"string",
            "description":"The domain or category for the child folder.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "FolderNumber":{
            "maxLength":30,
            "type":"string",
            "description":"This is a public unique identifier of the child folder.",
            "nullable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":50,
            "type":"string",
            "description":"The description of the child folder.",
            "nullable":false
        },
        "ParentFolderId":{
            "title":"Parent ID",
            "type":"integer",
            "description":"The parent folder identifier used to identify parents of a sub-folder.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "StripeCd":{
            "maxLength":30,
            "type":"string",
            "description":"The stripe code for the folder, such as ORA_SVC_CRM.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "UserPartyId":{
            "title":"User ID",
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        }
    }
}

Back to Top

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.

Body ()

Root Schema : smartTextFolders-SmartTextChildFolders-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "BuOrgId":{
            "type":"integer",
            "description":"The unique identifier of the business unit organization for the folder.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the smart text folder.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the smart text folder was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Domain":{
            "maxLength":30,
            "type":"string",
            "description":"The domain or category for the child folder.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "FolderId":{
            "title":"Folder ID",
            "type":"integer",
            "description":"The unique identifier of the smart text folder.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FolderNumber":{
            "maxLength":30,
            "type":"string",
            "description":"This is a public unique identifier of the child folder.",
            "nullable":true,
            "x-queryable":true
        },
        "FolderUniqueNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The public unique identifier of the child folder.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the smart text folder was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the smart text folder.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the smart text folder.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":50,
            "type":"string",
            "description":"The description of the child folder.",
            "nullable":false,
            "x-queryable":true
        },
        "ParentBuOrgId":{
            "type":"integer",
            "description":"The unique identifier of the business unit organization for the parent folder.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ParentFolderId":{
            "title":"Parent ID",
            "type":"integer",
            "description":"The parent folder identifier used to identify parents of a sub-folder.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ParentFolderName":{
            "title":"Name",
            "maxLength":50,
            "type":"string",
            "description":"The description of the parent folder.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentFolderUniqueNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The public unique identifier of the parent folder.",
            "nullable":false,
            "x-queryable":true
        },
        "PartyNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The public unique identifier of the user associated to this folder.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StripeCd":{
            "maxLength":30,
            "type":"string",
            "description":"The stripe code for the folder, such as ORA_SVC_CRM.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "UserPartyId":{
            "title":"User ID",
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top