機械翻訳について

ジャンプ先

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

カテゴリの作成

post

/crmRestApi/resources/11.13.18.05/categories

リクエスト

ヘッダー・パラメータ

• Metadata-Context:
  REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
• Upsert-Mode:
  次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サーバーは作成操作ではなくアップサート操作を実行します。 アップサート操作中、サーバーはペイロードに一致する既存のリソースを検索しようとします。 一致が見つかった場合、サーバーは、新しいリソースを作成するのではなく、既存のリソースを更新します。 見つからないかfalse (デフォルト)の場合、サーバーは作成操作を実行します。 アップサート操作は、有効日RESTリソースではサポートされていないことに注意してください。

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

• application/json

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

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

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

タイプ: object

ソースを表示

• BUOrgId: integer (int64)
  タイトル: Business Unit

  カテゴリに関連付けられたビジネス・ユニットの一意の識別子。
• BusinessUnitName: string
  タイトル: Business Unit Name

  最大長: 255

  カテゴリに関連付けられたビジネス・ユニットの名前。
• CategoryCode: string
  タイトル: Category Code

  最大長: 290

  カテゴリの公開一意識別子。
• CategoryName: string
  タイトル: Category Name

  最大長: 400

  カテゴリの名前。
• CategoryShortName: string
  タイトル: Category Short Name

  最大長: 240

  カテゴリの短縮名。 この値は、CategoryNameから自動生成されます。 ただし、必要に応じて名前を編集して一意の値にすることができます。
• CSSFlag: boolean
  タイトル: Visible in Customer Self-Service

  最大長: 1

  デフォルト値: true

  カテゴリが顧客セルフサービス・ポータルに表示されるかどうかを示します。
• EnabledFlag: boolean
  タイトル: Enabled

  最大長: 1

  デフォルト値: true

  カテゴリが使用可能かどうかを示します。 有効な場合、値はY、それ以外の場合はNです。
• OriginalSystemReference: string
  タイトル: Original System

  最大長: 255

  カテゴリのインポート元のシステムへの参照(インポートされている場合)。
• ParentCategoryCode: string
  タイトル: Parent Category Code

  最大長: 290

  親カテゴリの公開一意識別子。
• ParentCategoryId: integer (int64)
  タイトル: Parent Category ID

  親カテゴリの一意の識別子。 カテゴリがルート・カテゴリの場合、値はNULLです。
• StripeCd: string
  タイトル: Stripe Code

  最大長: 30

  サービス・リクエスト・カテゴリのアプリケーション・ストライプを示すコード。 受け入れられる値のリストは、参照ORA_SVC_STRIPE_CDで定義されます。

{
    "type":"object",
    "properties":{
        "CategoryCode":{
            "title":"Category Code",
            "maxLength":290,
            "type":"string",
            "description":"The public unique identifier of the category.",
            "nullable":false,
            "x-hints":{
                "dependencies":[
                    "CategoryName"
                ]
            }
        },
        "ParentCategoryCode":{
            "title":"Parent Category Code",
            "maxLength":290,
            "type":"string",
            "description":"The public unique identifier of the parent category.",
            "nullable":true,
            "x-queryable":false
        },
        "StripeCd":{
            "title":"Stripe Code",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the application stripe of the service request category. A list of accepted values is defined in the lookup ORA_SVC_STRIPE_CD.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "OriginalSystemReference":{
            "title":"Original System",
            "maxLength":255,
            "type":"string",
            "description":"The reference to the original system from which the category was imported (if imported).",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "CategoryId"
                ]
            }
        },
        "CategoryShortName":{
            "title":"Category Short Name",
            "maxLength":240,
            "type":"string",
            "description":"The short name of the category. This value is auto-generated from CategoryName. However, you can edit the name to make it a unique value, if required.",
            "nullable":false,
            "x-hints":{
                "dependencies":[
                    "CategoryCode",
                    "CategoryName"
                ]
            }
        },
        "CategoryName":{
            "title":"Category Name",
            "maxLength":400,
            "type":"string",
            "description":"The name of the category.",
            "nullable":false
        },
        "CSSFlag":{
            "title":"Visible in Customer Self-Service",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the category is visible in the customer self-service portal.",
            "nullable":false,
            "default":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BUOrgId":{
            "title":"Business Unit",
            "type":"integer",
            "description":"The unique identifier of the business unit associated with the category.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":18
            }
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the category is enabled. If enabled, the value is Y, else the value is N.",
            "nullable":false,
            "default":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BusinessUnitName":{
            "title":"Business Unit Name",
            "maxLength":255,
            "type":"string",
            "description":"The name of the business unit associated with the category.",
            "nullable":true
        },
        "ParentCategoryId":{
            "title":"Parent Category ID",
            "type":"integer",
            "description":"The unique identifier of the parent category. The value is NULL, if the category is the root category.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        }
    }
}

トップに戻る

応答

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

• application/json

デフォルトのレスポンス

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

ヘッダー

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

本文( )

ルート・スキーマ : categories-item-response

タイプ: object

ソースを表示

• BUOrgId: integer (int64)
  タイトル: Business Unit

  カテゴリに関連付けられたビジネス・ユニットの一意の識別子。
• BusinessUnitName: string
  タイトル: Business Unit Name

  最大長: 255

  カテゴリに関連付けられたビジネス・ユニットの名前。
• CategoryCode: string
  タイトル: Category Code

  最大長: 290

  カテゴリの公開一意識別子。
• CategoryId: integer (int64)
  タイトル: Category

  読取り専用: true

  カテゴリの一意の識別子。
• CategoryIdHierarchy: string
  タイトル: Category ID Hierarchy

  読取り専用: true

  最大長: 4000

  文字列形式のカテゴリ識別子の階層。 次に例を示します: 132787 > 567754。
• CategoryName: string
  タイトル: Category Name

  最大長: 400

  カテゴリの名前。
• CategoryShortName: string
  タイトル: Category Short Name

  最大長: 240

  カテゴリの短縮名。 この値は、CategoryNameから自動生成されます。 ただし、必要に応じて名前を編集して一意の値にすることができます。
• CreatedBy: string
  タイトル: Created By

  読取り専用: true

  最大長: 64

  カテゴリを作成したユーザー。
• CreationDate: string (date-time)
  タイトル: Creation Date

  読取り専用: true

  カテゴリが作成された日時。
• CSSFlag: boolean
  タイトル: Visible in Customer Self-Service

  最大長: 1

  デフォルト値: true

  カテゴリが顧客セルフサービス・ポータルに表示されるかどうかを示します。
• DeleteFlag: boolean
  タイトル: Can Delete

  読取り専用: true

  カテゴリが削除されたかどうかを示します。 デフォルト値はfalseです。
• Depth: integer (int64)
  タイトル: Depth

  読取り専用: true

  カテゴリ階層でサービス・カテゴリが発生する深さ。
• EnabledFlag: boolean
  タイトル: Enabled

  最大長: 1

  デフォルト値: true

  カテゴリが使用可能かどうかを示します。 有効な場合、値はY、それ以外の場合はNです。
• Hierarchy: string
  タイトル: Hierarchy

  読取り専用: true

  最大長: 4000

  文字列形式のカテゴリの階層。 たとえば、「ローミング」>「技術的な問題」です。
• LastUpdateDate: string (date-time)
  タイトル: Last Updated Date

  読取り専用: true

  カテゴリが最後に更新された日時。
• LastUpdatedBy: string
  タイトル: Last Updated By

  読取り専用: true

  最大長: 64

  カテゴリを最後に更新したユーザー。
• LastUpdateLogin: string
  タイトル: Last Update Login

  読取り専用: true

  最大長: 32

  行を最後に更新したユーザーに関連付けられたセッション・ログイン。
• LeafNodeFlag: boolean
  タイトル: Leaf Node

  読取り専用: true

  最大長: 12

  現在のカテゴリに子があるかどうかを示します。
• links: array Links
  タイトル: Links

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

  最大長: 255

  カテゴリのインポート元のシステムへの参照(インポートされている場合)。
• ParentCategoryCode: string
  タイトル: Parent Category Code

  最大長: 290

  親カテゴリの公開一意識別子。
• ParentCategoryId: integer (int64)
  タイトル: Parent Category ID

  親カテゴリの一意の識別子。 カテゴリがルート・カテゴリの場合、値はNULLです。
• RootCategoryCode: string
  タイトル: Root Category Code

  読取り専用: true

  最大長: 4000

  ルート・カテゴリ・コード
• StripeCd: string
  タイトル: Stripe Code

  最大長: 30

  サービス・リクエスト・カテゴリのアプリケーション・ストライプを示すコード。 受け入れられる値のリストは、参照ORA_SVC_STRIPE_CDで定義されます。
• UpdateFlag: boolean
  タイトル: Can Update

  読取り専用: true

  カテゴリが更新されたかどうかを示します。 デフォルト値はfalseです。

{
    "type":"object",
    "properties":{
        "CategoryId":{
            "title":"Category",
            "type":"integer",
            "description":"The unique identifier of the category.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CategoryCode":{
            "title":"Category Code",
            "maxLength":290,
            "type":"string",
            "description":"The public unique identifier of the category.",
            "nullable":false,
            "x-hints":{
                "dependencies":[
                    "CategoryName"
                ]
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the category was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CategoryIdHierarchy":{
            "title":"Category ID Hierarchy",
            "maxLength":4000,
            "type":"string",
            "description":"The hierarchy of the category identifiers in string format. For example: 132787 > 567754.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Depth":{
            "title":"Depth",
            "type":"integer",
            "description":"The depth at which the service category occurs in the category hierarchy.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Hierarchy":{
            "title":"Hierarchy",
            "maxLength":4000,
            "type":"string",
            "description":"The hierarchy of the category in a string format. For example Roaming > Technical Issue.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UpdateFlag":{
            "title":"Can Update",
            "type":"boolean",
            "description":"Indicates if the category has been updated. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the category is enabled. If enabled, the value is Y, else the value is N.",
            "nullable":false,
            "default":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BusinessUnitName":{
            "title":"Business Unit Name",
            "maxLength":255,
            "type":"string",
            "description":"The name of the business unit associated with the category.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentCategoryId":{
            "title":"Parent Category ID",
            "type":"integer",
            "description":"The unique identifier of the parent category. The value is NULL, if the category is the root category.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the category.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the category.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentCategoryCode":{
            "title":"Parent Category Code",
            "maxLength":290,
            "type":"string",
            "description":"The public unique identifier of the parent category.",
            "nullable":true,
            "x-queryable":false
        },
        "OriginalSystemReference":{
            "title":"Original System",
            "maxLength":255,
            "type":"string",
            "description":"The reference to the original system from which the category was imported (if imported).",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "CategoryId"
                ]
            }
        },
        "CategoryShortName":{
            "title":"Category Short Name",
            "maxLength":240,
            "type":"string",
            "description":"The short name of the category. This value is auto-generated from CategoryName. However, you can edit the name to make it a unique value, if required.",
            "nullable":false,
            "x-hints":{
                "dependencies":[
                    "CategoryCode",
                    "CategoryName"
                ]
            },
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Can Delete",
            "type":"boolean",
            "description":"Indicates if the category has been deleted. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "StripeCd":{
            "title":"Stripe Code",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the application stripe of the service request category. A list of accepted values is defined in the lookup ORA_SVC_STRIPE_CD.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LeafNodeFlag":{
            "title":"Leaf Node",
            "maxLength":12,
            "type":"boolean",
            "description":"Indicates whether the current category has any children.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CategoryName":{
            "title":"Category Name",
            "maxLength":400,
            "type":"string",
            "description":"The name of the category.",
            "nullable":false,
            "x-queryable":true
        },
        "CSSFlag":{
            "title":"Visible in Customer Self-Service",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the category is visible in the customer self-service portal.",
            "nullable":false,
            "default":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BUOrgId":{
            "title":"Business Unit",
            "type":"integer",
            "description":"The unique identifier of the business unit associated with the category.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":18
            },
            "x-queryable":true
        },
        "RootCategoryCode":{
            "title":"Root Category Code",
            "maxLength":4000,
            "type":"string",
            "description":"Root Category Code",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the category was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The session login associated with the user who last updated the row.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

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

タイプ: 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."
        }
    }
}

リンク

BusinessUnitLOV

操作: /crmRestApi/resources/11.13.18.05/serviceBusinessUnits

ログイン・ユーザーに関連付けられているビジネス・ユニットを示す値リスト。

LOVリンク関連では、次のプロパティが定義されます:

• ソース属性: BUOrgId;ターゲット属性: BusinessUnitId
• 表示属性: 名前、BusinessUnitId

StripeCdLOV

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

• ファインダ: LookupTypeFinder%3BLookupType%3DORA_SVC_STRIPE_CD

LOVリンク関連では、次のプロパティが定義されます:

• ソース属性: StripeCd;ターゲット属性: LookupCode
• 表示属性: 意味

YesNoLookupPVO

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

• ファインダ: LookupTypeFinder%3BLookupType%3DYES_NO

カテゴリの使用可能ステータスを示す値リスト。

LOVリンク関連では、次のプロパティが定義されます:

• ソース属性: CSSFlag;ターゲット属性: LookupCode
• 表示属性: 意味

トップに戻る

例:

次の例は、RESTリソースに対してPOSTリクエストを発行してカテゴリを作成する方法を示しています。

cURLコマンド

curl -u <username:password> \
 -X POST https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/categories  \
 -H 'Content-Type: application/vnd.oracle.adf.resourceitem+json'  | json_pp

リクエスト本文の例

次の例は、JSON形式のリクエスト本文のコンテンツを示しています。

{

"CategoryName":"Category-RLW",

"CategoryCode":"RLW"

}

レスポンス・ヘッダーの例

次に、レスポンス・ヘッダーの例を示します。

HTTP/1.1 201 OK
Date: Fri, 12 Aug 2016 09:02:50 GMT
Server: Oracle-HTTP-Server-11g
Content-Type: application/vnd.oracle.adf.resourceitem+json
Content-Language: en

レスポンス本文の例

次の例は、JSON形式のレスポンス本文のコンテンツを示しています。

{
    "CategoryId": 300100559072867,
    "ParentCategoryId": null,
    "CategoryName": "Category-RLW",
    "CategoryShortName": "RLW",
    "CategoryCode": "RLW",
    "ParentCategoryCode": null,
    "EnabledFlag": true,
    "CreatedBy": "SALES_ADMIN",
    "CreationDate": "2022-08-09T07:24:33+00:00",
    "LastUpdatedBy": "SALES_ADMIN",
    "LastUpdateDate": "2022-08-09T07:24:33.140+00:00",
    "LastUpdateLogin": "E5B2BD2625F67A21E0531C5CF00A59CE",
    "OriginalSystemReference": "300100559072867",
    "StripeCd": "ORA_SVC_CRM",
    "CSSFlag": true,
    "UpdateFlag": true,
    "DeleteFlag": true,
    "BUOrgId": 204,
    "BusinessUnitName": "Vision Operations",
    "Depth": null,
    "Hierarchy": null,
    "LeafNodeFlag": null,
    "CategoryIdHierarchy": null,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/categories/300100559072867",
            "name": "categories",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/categories/300100559072867",
            "name": "categories",
            "kind": "item"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/categories/300100559072867/lov/BusinessUnitLOV",
            "name": "BusinessUnitLOV",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/categories/300100559072867/lov/StripeCdLOV",
            "name": "StripeCdLOV",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/categories/300100559072867/lov/YesNoLookupPVO",
            "name": "YesNoLookupPVO",
            "kind": "collection"
        }
    ]
}

「トップに戻る」