機械翻訳について

ジャンプ先

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

処理関連の更新

patch

/crmRestApi/resources/11.13.18.05/actiontemplates/{TemplateId}/child/templateAction/{TemplateActionId}/child/actionRelation/{RelationId}

リクエスト

パス・パラメータ

• RelationId(required): integer(int64)
  処理プラン内の処理間の関係の一意の識別子。
• TemplateActionId(required): integer(int64)
  テンプレート処理の一意の識別子。
• TemplateId(required): integer(int64)
  処理プラン・テンプレートの一意の識別子。

ヘッダー・パラメータ

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

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

• application/json

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

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

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

タイプ: object

ソースを表示

• ActionStatusCd: string
  タイトル: Action Status

  最大長: 30

  デフォルト値: ORA_SVC_COMPLETED

  処理関係の依存関係条件を示すステータス・コード。 有効な値のリストは、参照ORA_SVC_AP_STATUS_CDで定義されます。
• ActionStatusCdMeaning: string
  タイトル: Action Status Value

  最大長: 255

  処理関係の処理ステータス参照コードに対応する表示値。
• DeletedFlag: boolean
  タイトル: Deleted

  最大長: 1

  デフォルト値: false

  処理依存関係が削除されたかどうかを示します。 デフォルト値はfalseです。
• DepTemplateActionId: integer (int64)
  タイトル: Dependent Template Action ID

  処理プラン内の依存処理の一意の識別子です。

{
    "type":"object",
    "properties":{
        "DeletedFlag":{
            "title":"Deleted",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the action dependency has been deleted. The default value is false.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ActionStatusCd":{
            "title":"Action Status",
            "maxLength":30,
            "type":"string",
            "description":"The status code which indicates the dependency condition of an action relation. A list of valid values is defined in the lookup ORA_SVC_AP_STATUS_CD.",
            "nullable":true,
            "default":"ORA_SVC_COMPLETED"
        },
        "ActionStatusCdMeaning":{
            "title":"Action Status Value",
            "maxLength":255,
            "type":"string",
            "description":"The display value corresponding to the action status lookup code for the action relation.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ActionStatusCd"
                ]
            }
        },
        "DepTemplateActionId":{
            "title":"Dependent Template Action ID",
            "type":"integer",
            "description":"The unique identifier of the dependent action in an action plan.",
            "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のデフォルト・バージョンを選択します。

本文( )

ルート・スキーマ : actiontemplates-templateAction-actionRelation-item-response

タイプ: object

ソースを表示

• ActionStatusCd: string
  タイトル: Action Status

  最大長: 30

  デフォルト値: ORA_SVC_COMPLETED

  処理関係の依存関係条件を示すステータス・コード。 有効な値のリストは、参照ORA_SVC_AP_STATUS_CDで定義されます。
• ActionStatusCdMeaning: string
  タイトル: Action Status Value

  最大長: 255

  処理関係の処理ステータス参照コードに対応する表示値。
• CreatedBy: string
  タイトル: Created By

  読取り専用: true

  最大長: 64

  アクションの依存関係を作成したユーザー。
• CreationDate: string (date-time)
  タイトル: Creation Date

  読取り専用: true

  アクション依存関係が作成された日時。
• DeletedFlag: boolean
  タイトル: Deleted

  最大長: 1

  デフォルト値: false

  処理依存関係が削除されたかどうかを示します。 デフォルト値はfalseです。
• DeleteFlag: boolean
  読取り専用: true

  処理関連を削除できるかどうかを示します。
• DepTemplateActionId: integer (int64)
  タイトル: Dependent Template Action ID

  処理プラン内の依存処理の一意の識別子です。
• DepTemplateActionNumber: string
  タイトル: Dependent Template Action Number

  最大長: 30

  依存処理のテンプレート処理参照番号です。
• DepTmpActionOrderNumber: integer (int64)
  タイトル: Sort Number

  読取り専用: true

  アクション・テンプレート内のアクションの表示順序。
• LastUpdateDate: string (date-time)
  タイトル: Last Update Date

  読取り専用: true

  アクションの依存関係が最後に更新された日時。
• LastUpdatedBy: string
  タイトル: Last Updated By

  読取り専用: true

  最大長: 64

  アクションの依存関係を最後に更新したユーザー。
• LastUpdateLogin: string
  タイトル: Last Update Login

  読取り専用: true

  最大長: 32

  アクションの依存関係を最後に更新したユーザーのログイン詳細。
• links: array Links
  タイトル: Links

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

  処理プラン内の処理間の関係の一意の識別子。
• TemplateActionId: integer (int64)
  タイトル: Template Action ID

  テンプレート処理の一意の識別子。
• TemplateActionNumber: string
  タイトル: Template Action Number

  最大長: 30

  テンプレート処理参照番号。
• UpdateFlag: boolean
  読取り専用: true

  処理関連を更新できるかどうかを示します。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the dependencies of an action.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the action dependency 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 dependencies of an action.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActionStatusCdMeaning":{
            "title":"Action Status Value",
            "maxLength":255,
            "type":"string",
            "description":"The display value corresponding to the action status lookup code for the action relation.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ActionStatusCd"
                ]
            },
            "x-queryable":true
        },
        "DepTemplateActionNumber":{
            "title":"Dependent Template Action Number",
            "maxLength":30,
            "type":"string",
            "description":"The template action reference number of a dependent action.",
            "nullable":false,
            "x-queryable":true
        },
        "TemplateActionNumber":{
            "title":"Template Action Number",
            "maxLength":30,
            "type":"string",
            "description":"The template action reference number.",
            "nullable":false,
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether the action relation can be deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DepTemplateActionId":{
            "title":"Dependent Template Action ID",
            "type":"integer",
            "description":"The unique identifier of the dependent action in an action plan.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates whether the action relation can be updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ActionStatusCd":{
            "title":"Action Status",
            "maxLength":30,
            "type":"string",
            "description":"The status code which indicates the dependency condition of an action relation. A list of valid values is defined in the lookup ORA_SVC_AP_STATUS_CD.",
            "nullable":true,
            "default":"ORA_SVC_COMPLETED",
            "x-queryable":true
        },
        "RelationId":{
            "title":"Relation ID",
            "type":"integer",
            "description":"The unique identifier of the relation between the actions in an action plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TemplateActionId":{
            "title":"Template Action ID",
            "type":"integer",
            "description":"The unique identifier of the template action.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DeletedFlag":{
            "title":"Deleted",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the action dependency has been deleted. The default value is false.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DepTmpActionOrderNumber":{
            "title":"Sort Number",
            "type":"integer",
            "description":"The order of display for an action within an action template.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date and time when the action dependency 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 details of the user who last updated the action dependency.",
            "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."
        }
    }
}

リンク

YesNoLookup

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

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

処理関係が削除されたかどうかを示す値リスト。

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

• ソース属性: DeletedFlag;ターゲット属性: LookupCode
• 表示属性: LookupCode

トップに戻る

例:

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

cURLコマンド

curl -u <username:password> \ -X PATCH -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/actiontemplates/300100118669128/child/templateAction/300100120240863/child/actionRelation/300100120242173

リクエスト本文の例

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

{
"DepTemplateActionId":"300100118669147"
}

レスポンス本文の例

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

{
"CreatedBy": "SALES_ADMIN",
"CreationDate": "2017-10-09T13:52:07+00:00",
"DeletedFlag": false,
"DepTemplateActionId": 300100118669147,
"LastUpdateDate": "2017-10-09T14:04:06+00:00",
"LastUpdateLogin": "5B1C798066630C0DE0538E09F20A9CA0",
"LastUpdatedBy": "SALES_ADMIN",
"RelationId": 300100120242173,
"TemplateActionId": 300100120240863,
"UpdateFlag": true,
"DeleteFlag": true,
"ActionStatusCd": null,
"links": [
 ...
 ]
}

「トップに戻る」