機械翻訳について

ジャンプ先

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

ソースの属性を返す

get

/api/{version}/mapping/attributes/{source}

サポートされるバージョン:

v4

リクエスト

パス・パラメータ

• source(required): string
  取得する属性のタイプ。例: daas、fcrm。

問合せパラメータ

• attributetype(required): string
• ignoresubscription(required): boolean
  デフォルト値: false
• inActive(required): string
  デフォルト値: N
• mapMode(required): string
• object(required): string
  DaaSのオブジェクトのタイプ(会社など)を指定します。

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

トップに戻る

応答

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

• application/xml
• application/json

200 レスポンス

成功

本文( )

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

タイプ: object

カタログ属性リスト。

ソースを表示

• catalogAttributes: array catalogAttributes

{
    "properties":{
        "catalogAttributes":{
            "items":{
                "$ref":"#/components/schemas/CatalogAttributes"
            },
            "type":"array"
        }
    },
    "description":"Catalog attribute list.",
    "type":"object"
}

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

タイプ: array

ソースを表示

• Array of: object CatalogAttributes

{
    "items":{
        "$ref":"#/components/schemas/CatalogAttributes"
    },
    "type":"array"
}

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

タイプ: object

ソースを表示

• active: string
• attributeDisplayName: string
• attributeId: integer (int64)
• attributeMsgKey: string
• attributeName: string
• isautosuggest: boolean
• objectName: string
• operations: array operations
• pickListValues: array pickListValues
• searchReturn: boolean
• tierLevel: string

{
    "properties":{
        "active":{
            "type":"string"
        },
        "attributeDisplayName":{
            "type":"string"
        },
        "attributeId":{
            "format":"int64",
            "type":"integer"
        },
        "attributeMsgKey":{
            "type":"string"
        },
        "attributeName":{
            "type":"string"
        },
        "isautosuggest":{
            "type":"boolean"
        },
        "objectName":{
            "type":"string"
        },
        "operations":{
            "items":{
                "$ref":"#/components/schemas/Operator"
            },
            "type":"array"
        },
        "pickListValues":{
            "items":{
                "$ref":"#/components/schemas/Lookup"
            },
            "type":"array"
        },
        "searchReturn":{
            "type":"boolean"
        },
        "tierLevel":{
            "type":"string"
        }
    },
    "type":"object"
}

ネストされたスキーマ : 操作

タイプ: array

ソースを表示

• Array of: string
  許可された値: [ "BETWEEN", "CONTAINS", "DOESNOTEXIST", "ENDSWITH", "EQUALS", "EXISTS", "GREATERTHAN", "GREATERTHANEQUALS", "ISBLANK", "ISNOTBLANK", "LESSTHAN", "LESSTHANEQUALS", "LIKE", "NOTBETWEEN", "RANGE", "STARTSWITH" ]

{
    "items":{
        "$ref":"#/components/schemas/Operator"
    },
    "type":"array"
}

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

タイプ: array

ソースを表示

• Array of: object Lookup

{
    "items":{
        "$ref":"#/components/schemas/Lookup"
    },
    "type":"array"
}

ネストされたスキーマ : 参照

タイプ: object

ソースを表示

• displayCode: string
• displayValue: string
• value: string

{
    "properties":{
        "displayCode":{
            "type":"string"
        },
        "displayValue":{
            "type":"string"
        },
        "value":{
            "type":"string"
        }
    },
    "type":"object"
}

404 レスポンス

リクエストされたリソースが見つかりませんでした。

500 レスポンス

リクエスト中に予期しないエラーが発生しました。

トップに戻る

例:

リクエストの例:

/api/v4/mapping/attributes/daas?object=COMPANY

出力例:

{
"catalogAttributes": [{
"attributeDisplayName": "Company ID",
"attributeId": "11385",
"attributeName": "id",
"objectName": "COMPANY",
"tierLevel": "STANDARD"
}, {
"attributeDisplayName": "Business Name",
"attributeId": "11386",
"attributeName": "name.display_name",
"objectName": "COMPANY",
"tierLevel": "STANDARD"
}, {
"attributeDisplayName": "OrganizationType",
"attributeId": "11387",
"attributeName": "info.organization_type",
"objectName": "COMPANY",
"tierLevel": "STANDARD"
}, ...]
}

エラー・レスポンス詳細:

{"errorMessage": "DCS-1 : The version of the service is not supported. Action: Provide the supported version for accessing the service." }

「トップに戻る」