機械翻訳について

ジャンプ先

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

住所書式レイアウトの取得

get

/crmRestApi/resources/11.13.18.05/addressStyleFormats/{CountryCode}/child/AddressStyleFormatLayout/{AddressStyleFormatLayoutUniqID}

リクエスト

パス・パラメータ

• AddressStyleFormatLayoutUniqID(required): string
  これは、住所形式の書式レイアウト・リソースの複合キーを構成し、住所形式の書式レイアウトのインスタンスを一意に識別するために使用される属性のハッシュ・キーです。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントは、ハッシュ・キーを取得するために住所形式の書式レイアウトの特定のインスタンスに移動するために、住所形式の書式レイアウト・コレクション・リソースを問い合せる必要があります。
• CountryCode(required): string
  住所形式の書式の国コード。 この値はユーザーが追加することも、空白のままにすることもできます。 手動で追加した場合、国コードの住所形式書式が返されます。空白のままにした場合、使用可能な住所形式書式のリスト全体が返されます。

問合せパラメータ

• dependency: string
  このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: dependency=ProductId=2
  
  フォーマット: <attr1>=<val1>,<attr2>=<value2>
• 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
• links: string
  このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>
  
  例:
  self,canonical
  
• onlyData: boolean
  リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。

ヘッダー・パラメータ

• 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のデフォルト・バージョンを選択します。

本文( )

ルート・スキーマ : addressStyleFormats-AddressStyleFormatLayout-item-response

タイプ: object

ソースを表示

• AttributeLabel: string
  読取り専用: true

  最大長: 80

  住所書式レイアウトの住所フィールド・ラベルまたはプロンプト。
• AttributeName: string
  読取り専用: true

  最大長: 120

  住所書式レイアウトの住所フィールド名。
• DelimiterAfter: string
  読取り専用: true

  最大長: 20

  属性がnullでない場合に属性の後ろに配置される1つ以上の文字を示します。
• DelimiterBefore: string
  読取り専用: true

  最大長: 20

  属性がnullでない場合に属性の前に配置される1つ以上の文字を示します。
• GeographyLevel: integer
  読取り専用: true

  住所書式レイアウトの住所フィールドの地理レベル。
• GeographyType: string
  読取り専用: true

  最大長: 30

  住所書式レイアウトの住所フィールドの地理タイプ。 未定義の場合、値はNULLです。
• LineNumber: 整数(int32)
  読取り専用: true

  属性を書式設定する行。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• MandatoryFlag: boolean
  読取り専用: true

  最大長: 1

  属性がレイアウトに必須かどうかを示します。 この値は住所フォーマットに基づいています。
• ポジション: 整数(int32)
  読取り専用: true

  属性を配置する行の位置。
• UppercaseFlag: boolean
  読取り専用: true

  最大長: 1

  属性を大文字に変換する必要があるかどうかを示します。

{
    "type":"object",
    "properties":{
        "AttributeLabel":{
            "maxLength":80,
            "type":"string",
            "description":"The address field label or prompt in address format layout.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Position":{
            "type":"integer",
            "description":"The position on the line where the attribute should be placed.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":2
            },
            "x-queryable":true
        },
        "GeographyType":{
            "maxLength":30,
            "type":"string",
            "description":"The geography type of the address field in address format layout. If undefined, the value is NULL.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "UppercaseFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether attribute should be translated to uppercase or not.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AttributeName":{
            "maxLength":120,
            "type":"string",
            "description":"The address field name in address format layout.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DelimiterBefore":{
            "maxLength":20,
            "type":"string",
            "description":"Indicates that one or more characters to be placed before attribute if attribute is not null.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GeographyLevel":{
            "type":"integer",
            "description":"The geography level of the address field in address format layout.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LineNumber":{
            "type":"integer",
            "description":"The line on which the attribute should be formatted.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":2
            },
            "x-queryable":true
        },
        "DelimiterAfter":{
            "maxLength":20,
            "type":"string",
            "description":"Indicates that one or more characters to be placed after attribute if attribute is not null.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MandatoryFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether attribute is mandatory for layout or not. This value is based on the address format.",
            "nullable":false,
            "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リソースに対するGETリクエストを発行することによって、アドレス書式レイアウトを取得する方法を示しています。

cURLコマンド

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/addressStyleFormats/AF/child/AddressStyleFormatLayout/100000015130095

レスポンス本文の例

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

{
            "AttributeLabel": "Address Line 1",
            "AttributeName": "Address1",
            "GeographyLevel": null,
            "GeographyType": null,
            "MandatoryFlag": true,
            "links": [
                ...
            ]
        }

「トップに戻る」