機械翻訳について

ジャンプ先

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

すべての成果を得る

get

/crmRestApi/resources/11.13.18.05/internalSRResolveOutcomeLookups

リクエスト

問合せパラメータ

• expand: string
  このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 カンマをセパレータとして使用して、複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
• fields: string
  このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。
  
  フォーマット : ?fields=Attribute1,Attribute2
  
  子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  コレクションを検索するための事前定義済ファインダとして使用されます。
  
  フォーマット : ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  使用可能なファインダ名および対応するファインダ変数を次に示します:
  
  

  • IsEnabledFinder : 解決結果が使用可能かどうかを示します。
    ファインダ変数:
  • PrimaryKey : 指定した主キーの解決結果を検索します。
    ファインダ変数:
    • LookupCode; string;指定した主キーを持つ解決結果参照コードを検索します。
• limit: integer
  このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
• links: string
  このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>
  
  例:
  self,canonical
  
• offset: integer
  リソース・コレクションの開始位置を定義するために使用します。 オフセットがリソース数を超えると、リソースは返されません。 デフォルト値は0です。
• onlyData: boolean
  リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
• orderBy: string
  このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。 パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。 昇順の場合は「asc」、降順の場合は「desc」を指定します。 デフォルト値は「asc」です。 たとえば、?orderBy=field1:asc,field2:descです
• q: string
  この問合せパラメータは、where句を定義します。 リソース・コレクションは、指定された式を使用して問い合せられます。 この問合せパラメータの値は、1つ以上の式です。 例 : ?q=部門番号>=10および<= 30;Loc!=NY
  
  フォーマット : ?q=expression1;expression2
  
  次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
  

  • CreatedBy; string;解決結果参照値を作成したユーザー。
  • CreationDate; string;解決結果参照値が作成された日時。
  • Description; string;解決結果参照の説明。
  • DisplaySequence; integer;解決結果のリストの表示順序。
  • EnabledFlag; boolean;解決結果が有効かどうかを示します。
  • EndDateActive; string;解決結果参照値が終了する日時。
  • LastUpdateDate; string;解決結果参照値が最後に更新された日時。
  • LastUpdateLogin; string;解決結果参照値を最後に更新したユーザーのログイン。
  • LastUpdatedBy; string;解決結果参照値を最後に更新したユーザー。
  • LookupCode; string;解決結果の参照コード。
  • LookupType; string;解決結果の参照タイプ。
  • 内容;文字列;解決結果の参照の意味。
  • StartDateActive; string;解決結果参照値がアクティブになる日時。
• totalResults: boolean
  "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。

ヘッダー・パラメータ

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

この操作にはリクエスト本文がありません。

トップに戻る

応答

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

• application/json

デフォルトのレスポンス

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

ヘッダー

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

本文( )

ルート・スキーマ : internalSRResolveOutcomeLookups

タイプ: object

ソースを表示

• count(required): integer
  現在の範囲で返されたリソース・インスタンスの数。
• hasMore(required): boolean
  サーバーで使用可能なリソースが、レスポンスで返されたサブセットより多いかどうかを示します。 値がtrueの場合、サーバーから取得するリソースがさらにあります。 デフォルト値はfalseです。
• items: array Items
  タイトル: Items

  コレクション内のアイテム。
• limit(required): integer
  サーバーで使用される実際のページング・サイズ。
• links(required): array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• offset(required): integer
  現在のページで使用されるオフセット値。
• totalResults: integer
  "?totalResults=true"の場合の推定行数。それ以外の場合、カウントは含まれません。

{
    "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/internalSRResolveOutcomeLookups-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"LOV",
        "group":"OEC"
    }
}

ネストされたスキーマ : アイテム

タイプ: array

タイトル: Items

コレクション内のアイテム。

ソースを表示

• Array of: object internalSRResolveOutcomeLookups-item-response

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

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

タイプ: array

タイトル: Links

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

ソースを表示

• Array of: object link

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

ネストされたスキーマ : internalSRResolveOutcomeLookups-item-response

タイプ: object

ソースを表示

• CreatedBy: string
  タイトル: Created By

  読取り専用: true

  最大長: 64

  解決結果参照値を作成したユーザー。
• CreationDate: string (date-time)
  タイトル: Creation Date

  読取り専用: true

  解決結果参照値が作成された日時。
• Description: string
  タイトル: Description

  読取り専用: true

  最大長: 240

  解決結果参照の摘要。
• DisplaySequence: integer (int64)
  タイトル: Display Sequence

  読取り専用: true

  解決結果のリストの表示順序。
• EnabledFlag: boolean
  タイトル: Enabled

  読取り専用: true

  最大長: 1

  解決結果が使用可能かどうかを示します。
• EndDateActive: 文字列(日付)
  タイトル: End Date

  読取り専用: true

  解決結果参照値が終了する日時。
• 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

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

  読取り専用: true

  最大長: 30

  解決結果の参照コード。
• LookupType: string
  タイトル: SR Outcome Type

  読取り専用: true

  最大長: 255

  解決結果の参照タイプ。
• Meaning: string
  タイトル: SR Outcome Meaning

  読取り専用: true

  最大長: 80

  解決結果の参照内容。
• srResolutionLookups: array Internal Service Request Outcome Resolutions
  タイトル: Internal Service Request Outcome Resolutions

  内部サービス・リクエスト結果解決リソースを使用すると、内部サービス・リクエストの結果を説明する解決コードを表示、作成、更新および削除できます。
• StartDateActive: 文字列(日付)
  タイトル: Start Date

  読取り専用: true

  解決結果参照値がアクティブになる日時。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the resolve outcome lookup value.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the resolve outcome lookup value was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the resolve outcome lookup.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the resolve outcome lookup value.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LookupType":{
            "title":"SR Outcome Type",
            "maxLength":255,
            "type":"string",
            "description":"The lookup type for the resolve outcome.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"The display sequence in the list of resolve outcomes.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "srResolutionLookups":{
            "title":"Internal Service Request Outcome Resolutions",
            "type":"array",
            "description":"The Internal Service Request outcome resolutions resource lets you view, create, update, and delete the resolution codes describing the outcome for an Internal Service Request.",
            "items":{
                "$ref":"#/components/schemas/internalSRResolveOutcomeLookups-srResolutionLookups-item-response"
            }
        },
        "LookupCode":{
            "title":"SR Outcome Code",
            "maxLength":30,
            "type":"string",
            "description":"The lookup code for the resolve outcome.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDateActive":{
            "title":"Start Date",
            "type":"string",
            "description":"The date and time when the resolve outcome lookup value will be active.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDateActive":{
            "title":"End Date",
            "type":"string",
            "description":"The date and time when the resolve outcome lookup value will end.",
            "format":"date",
            "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"
            }
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the resolve outcome is enabled.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Meaning":{
            "title":"SR Outcome Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The lookup meaning for the resolve outcome.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the resolve outcome lookup value 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 that last updated the resolve outcome lookup value.",
            "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"
    }
}

ネストされたスキーマ : 内部サービス・リクエスト結果解決

タイプ: array

タイトル: Internal Service Request Outcome Resolutions

内部サービス・リクエスト結果解決リソースを使用すると、内部サービス・リクエストの結果を説明する解決コードを表示、作成、更新および削除できます。

ソースを表示

• Array of: object internalSRResolveOutcomeLookups-srResolutionLookups-item-response

{
    "title":"Internal Service Request Outcome Resolutions",
    "type":"array",
    "description":"The Internal Service Request outcome resolutions resource lets you view, create, update, and delete the resolution codes describing the outcome for an Internal Service Request.",
    "items":{
        "$ref":"#/components/schemas/internalSRResolveOutcomeLookups-srResolutionLookups-item-response"
    }
}

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

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

ネストされたスキーマ : internalSRResolveOutcomeLookups-srResolutionLookups-item-response

タイプ: object

ソースを表示

• CreatedBy: string
  タイトル: Created By

  読取り専用: true

  最大長: 64

  解決結果解決参照値を作成したユーザー。
• CreationDate: string (date-time)
  タイトル: Creation Date

  読取り専用: true

  解決結果参照値が作成された日時。
• Description: string
  タイトル: Description

  読取り専用: true

  最大長: 240

  解決結果参照値の摘要。
• DisplaySequence: integer (int64)
  タイトル: Display Sequence

  読取り専用: true

  解決結果のリストの表示順序。
• EnabledFlag: boolean
  タイトル: Enabled

  読取り専用: true

  最大長: 1

  解決結果解決が使用可能かどうかを示します。
• EndDateActive: 文字列(日付)
  タイトル: End Date

  読取り専用: true

  解決結果解決参照値が終了する日時。
• 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

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

  読取り専用: true

  最大長: 30

  解決結果解決の参照コード。
• Meaning: string
  タイトル: SR Resolution Meaning

  読取り専用: true

  最大長: 80

  解決結果解決の参照タイプ。
• ParentLookupCode: string
  タイトル: SR Outcome Code

  読取り専用: true

  最大長: 255

  解決結果解決の参照内容です。
• StartDateActive: 文字列(日付)
  タイトル: Start Date

  読取り専用: true

  解決結果解決参照値がアクティブになる日時。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the resolve outcome resolution lookup value.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the resolve outcome lookup value was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the resolve outcome lookup value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the resolve outcome resolution lookup value.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"The display sequence in the list of resolve outcomes.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LookupCode":{
            "title":"SR Resolution Code",
            "maxLength":30,
            "type":"string",
            "description":"The lookup code for the resolve outcome resolution.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDateActive":{
            "title":"Start Date",
            "type":"string",
            "description":"The date and time when the resolve outcome resolution lookup value will be active.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDateActive":{
            "title":"End Date",
            "type":"string",
            "description":"The date and time when the resolve outcome resolution lookup value will be end dated.",
            "format":"date",
            "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"
            }
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the resolve outcome resolution is enabled.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentLookupCode":{
            "title":"SR Outcome Code",
            "maxLength":255,
            "type":"string",
            "description":"The lookup meaning for the resolve outcome resolution.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Meaning":{
            "title":"SR Resolution Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The lookup type for the resolve outcome resolution.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the resolve outcome resolution lookup value 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 that last updated the resolve outcome resolution lookup value.",
            "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"
    }
}

「トップに戻る」