Jump to

• Request
• Response

Get parent folders and smart texts

get

/crmRestApi/resources/11.13.18.05/smartTextFolderAndTexts/{UniqueIdentifier}/child/ParentFolderIdStandardTextFolderAndText

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.

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
• finder: string
  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:
  
  

  • FindByNameAndBuOrgId: Finds the data of folders and smart texts by name with optional variables for multi business unit support.
    Finder Variables:
    • BuOrgEnabled; string; The flag value of Y or N allowing the ability to override the default value.
    • BuOrgId; string; The business unit organization identifier for the query to run against.
    • Name; string; Partial name of the folder or smart text to run the query against. Search is case insensitive.
    • ShowNullBuOrgId; string; The flag value of Y or N allowing the ability to include null business unit organizations. Default is Y.
  • FindByObject: Finds a smart text and parent folder by a unique identifier and object.
    Finder Variables:
    • BuOrgEnabled; string.
    • BuOrgId; string.
    • Object; string; The object of the Smart Text, such as ServiceRequestVO.
    • ShowNullBuOrgId; string.
    • UniqueIdentifier; string; The unique identifier which is the StdTxtId of the Smart Text or the FolderId of the Smart Text folder.
  • PrimaryKey: Finds a Smart Text or folder by the unique identifier.
    Finder Variables:
    • UniqueIdentifier; integer; The unique identifier which is the StdTxtId of the Smart Text or the FolderId of the Smart Text folder.
• limit: integer
  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.
• 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
  
• offset: integer
  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.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  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
• q: string
  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:
  

  • BuOrgId; number; The unique identifier of the business unit for the parent record that primarily uses the Smart Text or folder.
  • CreatedBy; string; The user who created the smart text or smart text folder.
  • CreationDate; string; The date and time when the smart text or smart text folder for the parent record was created.
  • Domain; string; The domain or category for the folder or text.
  • LastUpdateDate; string; The login of the user who last updated the smart text or smart text folder for the parent record.
  • LastUpdateLogin; string; The user who last updated the smart text or smart text folder for the parent record.
  • LastUpdatedBy; string; The date when the smart text or smart text folder for the parent record was last updated.
  • Name; string; The name of the smart text or smart text folder.
  • Object; string; The primary object of the smart text or folder.
  • ParentFolderId; integer; The name of the parent folder for the smart text or smart text folder.
  • Scope; string; 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; The stripe code for the folder, such as ORA_SVC_CRM.
  • Type; string; The type of the source record. The valid values are Text and Folder.
  • UniqueIdentifier; integer; 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; The primary unique identifier of the Smart Text or folder for the parent record.
  • UserPartyId; integer; The scope of the smart text or smart text folder. The list of valid values are ORA_SVC_USER and ORA_SVC_GLOBAL.
• totalResults: boolean
  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

• 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 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 : smartTextFolderAndTexts-ParentFolderIdStandardTextFolderAndText

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/smartTextFolderAndTexts-ParentFolderIdStandardTextFolderAndText-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object smartTextFolderAndTexts-ParentFolderIdStandardTextFolderAndText-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/smartTextFolderAndTexts-ParentFolderIdStandardTextFolderAndText-item-response"
    }
}

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 : smartTextFolderAndTexts-ParentFolderIdStandardTextFolderAndText-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The date when the smart text or smart text folder for the parent record was last updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the smart text or smart text folder for the parent record was created.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the smart text or smart text folder.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UniqueNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"The primary unique identifier of the Smart Text or folder for the parent record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentFolderId":{
            "title":"Parent ID",
            "type":"integer",
            "description":"The name of the parent folder for the smart text or smart text folder.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Name":{
            "maxLength":"50",
            "type":"string",
            "description":"The name of the smart text or smart text folder.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Type":{
            "maxLength":"6",
            "type":"string",
            "description":"The type of the source record. The valid values are Text and Folder.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UniqueIdentifier":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Scope":{
            "maxLength":"20",
            "type":"string",
            "description":"The scope of the smart text or smart text folder. The list of valid values are ORA_SVC_USER and ORA_SVC_GLOBAL.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StripeCd":{
            "maxLength":"30",
            "type":"string",
            "description":"The stripe code for the folder, such as ORA_SVC_CRM.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Object":{
            "maxLength":"150",
            "type":"string",
            "description":"The primary object of the smart text or folder.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Domain":{
            "maxLength":"240",
            "type":"string",
            "description":"The domain or category for the folder or text.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BuOrgId":{
            "type":"number",
            "description":"The unique identifier of the business unit for the parent record that primarily uses the Smart Text or folder.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UserPartyId":{
            "title":"User ID",
            "type":"integer",
            "description":"The scope of the smart text or smart text folder. The list of valid values are ORA_SVC_USER and ORA_SVC_GLOBAL.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The login of the user who last updated the smart text or smart text folder for the parent record.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The user who last updated the smart text or smart text folder for the parent record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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