機械翻訳について

ジャンプ先

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

ビジネス・プランSWOTの更新

patch

/crmRestApi/resources/11.13.18.05/businessPlans/{BusinessPlanId}/child/Swot/{SWOTId}

リクエスト

パス・パラメータ

• BusinessPlanId(required): integer(int64)
  ビジネス・プランの一意の識別子。
• SWOTId(required): integer(int64)
  ビジネス・プランSWOTの一意の識別子。

ヘッダー・パラメータ

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

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

• application/json

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

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

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

タイプ: object

ソースを表示

• Description: string
  タイトル: Description

  最大長: 2000

  SWOTの摘要。
• SWOTNumber: string
  タイトル: Number

  最大長: 64

  ビジネス・プランSWOTの代替キー識別子。

{
    "type":"object",
    "properties":{
        "SWOTNumber":{
            "title":"Number",
            "maxLength":64,
            "type":"string",
            "description":"The alternate key identifier for the business plan SWOT.",
            "nullable":false
        },
        "Description":{
            "title":"Description",
            "maxLength":2000,
            "type":"string",
            "description":"The description of the SWOT.",
            "nullable":false
        }
    }
}

トップに戻る

応答

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

• application/json

デフォルトのレスポンス

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

ヘッダー

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

本文( )

ルート・スキーマ : businessPlans-Swot-item-response

タイプ: object

ソースを表示

• BusinessPlanId: integer (int64)
  タイトル: Business Plan ID

  ビジネス・プランの一意の識別子。
• BusinessPlanNumber: string
  タイトル: Business Plan Number

  最大長: 64

  親PUID。
• CreatedBy: string
  タイトル: Created By

  読取り専用: true

  最大長: 64

  レコードを作成したユーザー。
• CreationDate: string (date-time)
  タイトル: Creation Date

  読取り専用: true

  レコードが作成された日付。
• Description: string
  タイトル: Description

  最大長: 2000

  SWOTの摘要。
• 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

  リソース・インスタンスに関連付けられたリンク関係。
• SWOTId: integer (int64)
  タイトル: SWOT ID

  ビジネス・プランSWOTの一意の識別子。
• SWOTNumber: string
  タイトル: Number

  最大長: 64

  ビジネス・プランSWOTの代替キー識別子。
• SWOTTypeCode: string
  タイトル: Type Code

  最大長: 30

  ビジネス・プランSWOTのタイプを示すコード。 有効な値のリストは、参照ORA_ZCA_BUS_PLAN_SWOTで定義されます。 指定可能な値は、Opportunity(商談)、Strength(強さ)、Threat(脅威)、Weakmess(弱い)です。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "SWOTTypeCode":{
            "title":"Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the type of business plan SWOT. A list of valid values is defined in the lookup ORA_ZCA_BUS_PLAN_SWOT. Possible values are Opportunity, Strength, Threat, or Weakmess.",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Description":{
            "title":"Description",
            "maxLength":2000,
            "type":"string",
            "description":"The description of the SWOT.",
            "nullable":false,
            "x-queryable":true
        },
        "BusinessPlanId":{
            "title":"Business Plan ID",
            "type":"integer",
            "description":"The unique identifier of the business plan.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SWOTId":{
            "title":"SWOT ID",
            "type":"integer",
            "description":"The unique identifier of the business plan SWOT.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SWOTNumber":{
            "title":"Number",
            "maxLength":64,
            "type":"string",
            "description":"The alternate key identifier for the business plan SWOT.",
            "nullable":false,
            "x-queryable":true
        },
        "BusinessPlanNumber":{
            "title":"Business Plan Number",
            "maxLength":64,
            "type":"string",
            "description":"Parent puid.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "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."
        }
    }
}

トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対してPATCHリクエストを発行することによって、ビジネス・プランSWOTを更新する方法を示しています。

cURLコマンド

- curl -u <username:password> \ -X http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/businessPlans/300100091979253/child/Swot/300100091979257

リクエスト本文の例

次に、JSON形式のリクエスト本文の例を示します。

{
"Description":"Threat"
}

レスポンス本文の例

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

{
"BusinessPlanId": 300100091979253,
"SWOTId": 300100091979257,
"CreatedBy": "MHoope",
"CreationDate": "2016-12-12T03:32:28-08:00",
"LastUpdateDate": "2016-12-12T03:39:17-08:00",
"LastUpdateLogin": "4373F6AF02325539E05364C0F20A8DA6",
"LastUpdatedBy": "MHoope",
"Description": "Threat",
"SWOTTypeCode": "THREAT",
"SWOTNumber": "CDRM_1001",
...
}

「トップに戻る」