機械翻訳について

ジャンプ先

• リクエスト
• レスポンス

スマート・テキストの子フォルダの更新

patch

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

リクエスト

パス・パラメータ

• FolderId(required): integer(int64)
  スマート・テキスト・フォルダの一意の識別子。
• FolderId2(required): integer(int64)
  このパラメータの値は、リソース・アイテムを一意に識別するために使用されるキーのハッシュである可能性があります。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントはフィルタを使用してコレクション・リソースを問い合せ、特定のリソース・アイテムにナビゲートする必要があります。 例: products?q=InventoryItemId=

ヘッダー・パラメータ

• Metadata-Context:
  REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

サポートされるメディア・タイプ

• application/json

リクエスト本文 - application/json ()

次の表では、このタスクのリクエストの本文パラメータについて説明します。

ルート・スキーマ : スキーマ

タイプ: object

ソースを表示

• BuOrgId: integer (int64)
  フォルダのビジネス・ユニット組織の一意の識別子。
• Domain: string
  最大長: 30

  子フォルダのドメインまたはカテゴリ。
• FolderNumber: string
  最大長: 30

  これは子フォルダの公開一意識別子です。
• Name: string
  タイトル: Name

  最大長: 50

  子フォルダの説明。
• ParentFolderId: integer (int64)
  タイトル: Parent ID

  サブフォルダの親を識別するために使用する親フォルダ識別子。
• StripeCd: string
  最大長: 30

  フォルダのストライプ・コード(ORA_SVC_CRMなど)。
• UserPartyId: integer (int64)
  タイトル: User ID

  スマート・テキスト・フォルダが属するユーザーの一意の識別子。 値が指定されていない場合、フォルダはグローバル標準フォルダです。

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

トップに戻る

応答

サポートされるメディア・タイプ

• application/json

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。

ヘッダー

• Metadata-Context(required):
  REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version(required):
  RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

本文( )

ルート・スキーマ : smartTextFolders-SmartTextChildFolders-item-response

タイプ: object

ソースを表示

• BuOrgId: integer (int64)
  フォルダのビジネス・ユニット組織の一意の識別子。
• CreatedBy: string
  タイトル: Created By

  読取り専用: true

  最大長: 64

  スマート・テキスト・フォルダを作成したユーザー。
• CreationDate: string (date-time)
  タイトル: Creation Date

  読取り専用: true

  スマート・テキスト・フォルダが作成された日時。
• Domain: string
  最大長: 30

  子フォルダのドメインまたはカテゴリ。
• FolderId: integer (int64)
  タイトル: Folder ID

  読取り専用: true

  スマート・テキスト・フォルダの一意の識別子。
• FolderNumber: string
  最大長: 30

  これは子フォルダの公開一意識別子です。
• FolderUniqueNumber: string
  最大長: 30

  子フォルダの公開一意識別子。
• LastUpdateDate: string (date-time)
  タイトル: Last Updated Date

  読取り専用: true

  スマート・テキスト・フォルダが最後に更新された日付。
• LastUpdatedBy: string
  タイトル: Last Updated By

  読取り専用: true

  最大長: 64

  スマート・テキスト・フォルダを最後に更新したユーザー。
• LastUpdateLogin: string
  タイトル: Last Update Login

  読取り専用: true

  最大長: 32

  スマート・テキスト・フォルダを最後に更新したユーザーのログイン。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• Name: string
  タイトル: Name

  最大長: 50

  子フォルダの説明。
• ParentBuOrgId: integer (int64)
  読取り専用: true

  親フォルダのビジネス・ユニット組織の一意の識別子。
• ParentFolderId: integer (int64)
  タイトル: Parent ID

  サブフォルダの親を識別するために使用する親フォルダ識別子。
• ParentFolderName: string
  タイトル: Name

  読取り専用: true

  最大長: 50

  親フォルダの説明。
• ParentFolderUniqueNumber: string
  最大長: 30

  親フォルダの公開一意識別子。
• PartyNumber: string
  読取り専用: true

  最大長: 30

  このフォルダに関連付けられたユーザーの公開一意識別子。
• StripeCd: string
  最大長: 30

  フォルダのストライプ・コード(ORA_SVC_CRMなど)。
• UserPartyId: integer (int64)
  タイトル: User ID

  スマート・テキスト・フォルダが属するユーザーの一意の識別子。 値が指定されていない場合、フォルダはグローバル標準フォルダです。

{
    "type":"object",
    "properties":{
        "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
        },
        "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
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the smart text folder.",
            "nullable":false,
            "readOnly":true,
            "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
        },
        "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
        },
        "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
        },
        "PartyNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The public unique identifier of the user associated to this 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
        },
        "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
        },
        "FolderNumber":{
            "maxLength":30,
            "type":"string",
            "description":"This is a public unique identifier of the child folder.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ParentFolderName":{
            "title":"Name",
            "maxLength":50,
            "type":"string",
            "description":"The description of the parent folder.",
            "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
        },
        "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
        },
        "FolderUniqueNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The public unique identifier of the child folder.",
            "nullable":false,
            "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
        },
        "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
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

• Array of: object link

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

ネストされたスキーマ : リンク

タイプ: object

ソースを表示

• href: string
  タイトル: hyperlink reference

  関連リソースへのURI。
• kind: string
  タイトル: kind

  許可された値: [ "collection", "item", "describe", "other" ]

  関連リソースの種類。
• name: string
  タイトル: name

  関連リソースへのリンクの名前。
• properties: object properties
• rel: string
  タイトル: relation

  許可された値: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  リソース・インスタンスとの関係の名前。 例: 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."
                }
            }
        }
    }
}

ネストされたスキーマ : properties

タイプ: object

ソースを表示

• changeIndicator: string
  リソース・インスタンスのインジケータまたはETag値を変更します。

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

「トップに戻る」