機械翻訳について

移動

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

認証されたユーザーのアクセス・トークンの取得

post

/system/api/v1/security/token

このコールは、基本承認を使用して行うことができます。 このエンド・ポイントは、クライアント・アプリケーションのトークンの取得には使用できません。

リクエスト

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

• application/json

本文()

リクエスト本文は、リクエストの詳細を定義します。

ルート・スキーマ : V1AuthTokenRequestInfo

型: object

Show Source

• refreshToken(optional): string
  指定した場合、指定したリフレッシュ・トークンにアクセス・トークンが取得されます。 認証済ユーザーの場合、その他のアクセス・トークンが取得されます。

{
    "type":"object",
    "properties":{
        "refreshToken":{
            "type":"string",
            "description":"If specified, access token will be obtained for specified refresh token. Else access token will be obtained for authenticated user.",
            "required":false
        }
    }
}

トップに戻る

レスポンス

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

• application/json

200レスポンス

OK

本文()

ルート・スキーマ : AuthToken

型: object

認証トークンの詳細。

Show Source

• accessToken(optional): string
  アクセス・トークン
• expiresInMillis(optional): integer(int64)
  アクセス・トークンduration(in ms)。

  例: 1209600000
• refreshToken(optional): string
  リフレッシュ・トークン
• tokenType(optional): string
  アクセス・トークン・タイプ。

  例: Bearer

{
    "type":"object",
    "properties":{
        "tokenType":{
            "type":"string",
            "example":"Bearer",
            "description":"Access token type."
        },
        "accessToken":{
            "type":"string",
            "description":"Access token."
        },
        "refreshToken":{
            "type":"string",
            "description":"Refresh token."
        },
        "expiresInMillis":{
            "type":"integer",
            "format":"int64",
            "example":"1209600000",
            "description":"Access token duration(in ms)."
        }
    },
    "description":"Auth token details."
}

400レスポンス

不正な引数

本文()

ルート・スキーマ : ExceptionDetail

型: object

RESTリクエストのエラー詳細。 HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 このような場合は、エラー・レスポンス本文に追加情報が含まれている必要があります。 追加情報はオプションですが、指定すると、例外詳細の形式になります。

Show Source

• detail(optional): string
  この問題の発生に固有の説明。 人間が判読できる、場合によっては複数行の詳細で、問題を詳細に説明しています。
• instance(optional): string
  エラーの詳細を提供するURIをリンクに追加します。
• o:errorCode(optional): string
  アプリケーション・エラー・コード。HTTPエラー・コードとは異なります。
• o:errorDetails(optional): array o:errorDetails
  階層構造に複数のエラーがある場合もあります。
• o:errorPath(optional): string
  エラーが発生した場所を示すXPathまたはJSONパス。
• status(optional): integer(int32)
  HTTPステータス・コード。 例外に対応するHTTPステータス・コード。 リソースが存在しない場合の例外として、HTTPステータスは`404`になります。
• title(optional): string
  問題の短く、判読可能なサマリー。 ページをローカライズする場合を除いて、問題の後続の出現時にはサマリー**を変更しないでください。
• type(optional): string
  問題のタイプを識別する絶対URI。 このURIが参照解除されると、**は、HTMLページなどの問題の判読可能なサマリーを提供するものとなります。

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"Absolute URI that identifies the problem type. When this URI dereferenced, it **should** provide a human-readable summary of the problem, for example, as a HTML page."
        },
        "title":{
            "type":"string",
            "description":"Short, human-readable summary of the problem. The summary **should not** change for subsequent occurrences of the problem, except for purposes of localization."
        },
        "status":{
            "type":"integer",
            "format":"int32",
            "description":"HTTP status code. The corresponding HTTP status code for the exception. For exception that includes a resource does not exist would have a HTTP status of `404`."
        },
        "detail":{
            "type":"string",
            "description":"Description specific to this occurrence of the problem. The human readable, potentially multi-line details describing the problem in more details."
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error."
        },
        "o:errorCode":{
            "type":"string",
            "description":"Application error code, which is different from HTTP error code."
        },
        "o:errorPath":{
            "type":"string",
            "description":"XPath or JSON path to indicate where the error occurs."
        },
        "o:errorDetails":{
            "type":"array",
            "description":"Multiple errors can be organized in a hierarchical structure.",
            "items":{
                "$ref":"#/definitions/ExceptionDetail"
            }
        }
    },
    "description":"Error details for a REST request.  In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such these cases, the additional information must be included in the error response body. The additional information is optional, but if provided, it will be in the form of exception detail."
}

ネストされたスキーマ: o:errorDetails

型: array

階層構造に複数のエラーがある場合もあります。

Show Source

• Array of: object ExceptionDetail
  RESTリクエストのエラー詳細。 HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 このような場合は、エラー・レスポンス本文に追加情報が含まれている必要があります。 追加情報はオプションですが、指定すると、例外詳細の形式になります。

{
    "type":"array",
    "description":"Multiple errors can be organized in a hierarchical structure.",
    "items":{
        "$ref":"#/definitions/ExceptionDetail"
    }
}

403レスポンス

禁止

本文()

ルート・スキーマ : ExceptionDetail

型: object

RESTリクエストのエラー詳細。 HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 このような場合は、エラー・レスポンス本文に追加情報が含まれている必要があります。 追加情報はオプションですが、指定すると、例外詳細の形式になります。

Show Source

• detail(optional): string
  この問題の発生に固有の説明。 人間が判読できる、場合によっては複数行の詳細で、問題を詳細に説明しています。
• instance(optional): string
  エラーの詳細を提供するURIをリンクに追加します。
• o:errorCode(optional): string
  アプリケーション・エラー・コード。HTTPエラー・コードとは異なります。
• o:errorDetails(optional): array o:errorDetails
  階層構造に複数のエラーがある場合もあります。
• o:errorPath(optional): string
  エラーが発生した場所を示すXPathまたはJSONパス。
• status(optional): integer(int32)
  HTTPステータス・コード。 例外に対応するHTTPステータス・コード。 リソースが存在しない場合の例外として、HTTPステータスは`404`になります。
• title(optional): string
  問題の短く、判読可能なサマリー。 ページをローカライズする場合を除いて、問題の後続の出現時にはサマリー**を変更しないでください。
• type(optional): string
  問題のタイプを識別する絶対URI。 このURIが参照解除されると、**は、HTMLページなどの問題の判読可能なサマリーを提供するものとなります。

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"Absolute URI that identifies the problem type. When this URI dereferenced, it **should** provide a human-readable summary of the problem, for example, as a HTML page."
        },
        "title":{
            "type":"string",
            "description":"Short, human-readable summary of the problem. The summary **should not** change for subsequent occurrences of the problem, except for purposes of localization."
        },
        "status":{
            "type":"integer",
            "format":"int32",
            "description":"HTTP status code. The corresponding HTTP status code for the exception. For exception that includes a resource does not exist would have a HTTP status of `404`."
        },
        "detail":{
            "type":"string",
            "description":"Description specific to this occurrence of the problem. The human readable, potentially multi-line details describing the problem in more details."
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error."
        },
        "o:errorCode":{
            "type":"string",
            "description":"Application error code, which is different from HTTP error code."
        },
        "o:errorPath":{
            "type":"string",
            "description":"XPath or JSON path to indicate where the error occurs."
        },
        "o:errorDetails":{
            "type":"array",
            "description":"Multiple errors can be organized in a hierarchical structure.",
            "items":{
                "$ref":"#/definitions/ExceptionDetail"
            }
        }
    },
    "description":"Error details for a REST request.  In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such these cases, the additional information must be included in the error response body. The additional information is optional, but if provided, it will be in the form of exception detail."
}

ネストされたスキーマ: o:errorDetails

型: array

階層構造に複数のエラーがある場合もあります。

Show Source

• Array of: object ExceptionDetail
  RESTリクエストのエラー詳細。 HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 このような場合は、エラー・レスポンス本文に追加情報が含まれている必要があります。 追加情報はオプションですが、指定すると、例外詳細の形式になります。

{
    "type":"array",
    "description":"Multiple errors can be organized in a hierarchical structure.",
    "items":{
        "$ref":"#/definitions/ExceptionDetail"
    }
}

500レスポンス

内部サーバー・エラー

本文()

ルート・スキーマ : ExceptionDetail

型: object

RESTリクエストのエラー詳細。 HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 このような場合は、エラー・レスポンス本文に追加情報が含まれている必要があります。 追加情報はオプションですが、指定すると、例外詳細の形式になります。

Show Source

• detail(optional): string
  この問題の発生に固有の説明。 人間が判読できる、場合によっては複数行の詳細で、問題を詳細に説明しています。
• instance(optional): string
  エラーの詳細を提供するURIをリンクに追加します。
• o:errorCode(optional): string
  アプリケーション・エラー・コード。HTTPエラー・コードとは異なります。
• o:errorDetails(optional): array o:errorDetails
  階層構造に複数のエラーがある場合もあります。
• o:errorPath(optional): string
  エラーが発生した場所を示すXPathまたはJSONパス。
• status(optional): integer(int32)
  HTTPステータス・コード。 例外に対応するHTTPステータス・コード。 リソースが存在しない場合の例外として、HTTPステータスは`404`になります。
• title(optional): string
  問題の短く、判読可能なサマリー。 ページをローカライズする場合を除いて、問題の後続の出現時にはサマリー**を変更しないでください。
• type(optional): string
  問題のタイプを識別する絶対URI。 このURIが参照解除されると、**は、HTMLページなどの問題の判読可能なサマリーを提供するものとなります。

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"Absolute URI that identifies the problem type. When this URI dereferenced, it **should** provide a human-readable summary of the problem, for example, as a HTML page."
        },
        "title":{
            "type":"string",
            "description":"Short, human-readable summary of the problem. The summary **should not** change for subsequent occurrences of the problem, except for purposes of localization."
        },
        "status":{
            "type":"integer",
            "format":"int32",
            "description":"HTTP status code. The corresponding HTTP status code for the exception. For exception that includes a resource does not exist would have a HTTP status of `404`."
        },
        "detail":{
            "type":"string",
            "description":"Description specific to this occurrence of the problem. The human readable, potentially multi-line details describing the problem in more details."
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error."
        },
        "o:errorCode":{
            "type":"string",
            "description":"Application error code, which is different from HTTP error code."
        },
        "o:errorPath":{
            "type":"string",
            "description":"XPath or JSON path to indicate where the error occurs."
        },
        "o:errorDetails":{
            "type":"array",
            "description":"Multiple errors can be organized in a hierarchical structure.",
            "items":{
                "$ref":"#/definitions/ExceptionDetail"
            }
        }
    },
    "description":"Error details for a REST request.  In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such these cases, the additional information must be included in the error response body. The additional information is optional, but if provided, it will be in the form of exception detail."
}

ネストされたスキーマ: o:errorDetails

型: array

階層構造に複数のエラーがある場合もあります。

Show Source

• Array of: object ExceptionDetail
  RESTリクエストのエラー詳細。 HTTPエラー・コードおよびエラー・メッセージに加えて、リクエストが失敗したときにクライアントに追加情報を提供することが適切な場合もあります。 このような場合は、エラー・レスポンス本文に追加情報が含まれている必要があります。 追加情報はオプションですが、指定すると、例外詳細の形式になります。

{
    "type":"array",
    "description":"Multiple errors can be organized in a hierarchical structure.",
    "items":{
        "$ref":"#/definitions/ExceptionDetail"
    }
}

トップに戻る