アクティビティ・ログ用のREST API

200レスポンス

OK

ルート・スキーマ : カテゴリ

型: object

カテゴリのリストです。

Show Source

count(optional): integer(int64)

レスポンス内のリソースの合計数。

例: 10
hasMore(optional): boolean

コレクションには、リクエストに一致する多くの要素があります。ページ・リクエストを作成し、ページがすべての要素を返すのに十分な大きさでない場合に、返されるアイテムが他にもあるかどうかを示します。

例: true
items(optional): array items

コレクションに含まれる特異なリソース。
limit(optional): integer(int64)

実際のレスポンス・サイズ制限。リクエストで指定されている制限値が大きすぎる場合、または制限が指定されていない場合、レスポンスでは使用される制限が指定されます。

例: 10
links(optional): array links

このリソースの関連リソースおよびアクションへのリンク。リソースの正規表現へのリンクを含む自己リンクを少なくとも1つ含める必要があります。
offset(optional): integer(int64)

使用される実際のレスポンス・オフセット。リクエストでオフセットが指定されていない場合、レスポンスに実際のオフセットが指定されます。

例: 0
totalResults(optional): integer(int64)

リクエストに一致するリソースの合計数。指定した場合は、使用可能なアイテムの合計数です。指定されない場合、合計が不明か、または戻り不可能です。この値を計算するとき、ページング制限またはオフセットは無視されます。 `totalResults`パラメータがサポートされていて、クライアントによって`true`に設定されている場合にのみ返されます。

例: 10

{
    "type":"object",
    "properties":{
        "hasMore":{
            "type":"boolean",
            "example":true,
            "description":"Collection has more elements that match the request. Indicates whether there are more items to be returned when a paged request is made and the page was not big enough to return all elements."
        },
        "offset":{
            "type":"integer",
            "format":"int64",
            "example":0,
            "description":"Actual response offset used. If the request specifies no offset then the actual offset is provided in the response."
        },
        "count":{
            "type":"integer",
            "format":"int64",
            "example":10,
            "description":"Total number of resources in the response."
        },
        "limit":{
            "type":"integer",
            "format":"int64",
            "example":10,
            "description":"Actual response size limit used. If the request specifies too large a limit, or does not specify a limit then the response will specify the limit used."
        },
        "totalResults":{
            "type":"integer",
            "format":"int64",
            "example":10,
            "description":"Total number of resources that match the request. If provided, this is the total number of available items. If not specified the total is not known, or is not viable to return. Paging limits or offsets are ignored when calculating this value. Only returned if the `totalResults` parameter is supported and is set to `true` by the client."
        },
        "items":{
            "type":"array",
            "description":"Singular resources contained in the collection.",
            "items":{
                "$ref":"#/definitions/Category"
            }
        },
        "links":{
            "type":"array",
            "description":"Link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"List of Category."
}

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

型: array

コレクションに含まれる特異なリソース。

Show Source

Array of: object Category

カテゴリ情報。

{
    "type":"array",
    "description":"Singular resources contained in the collection.",
    "items":{
        "$ref":"#/definitions/Category"
    }
}

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

型: array

このリソースの関連リソースおよびアクションへのリンク。リソースの正規表現へのリンクを含む自己リンクを少なくとも1つ含める必要があります。

Show Source

Array of: object Link

RESTリンクおよび関連メタデータ。レスポンスがリンクを提供する場合(リソース自体への`self`リンクなど)、提供されたリンクには、このリンク構造で定義された1つ以上のプロパティが含まれます。

{
    "type":"array",
    "description":"Link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

ネストされたスキーマ : カテゴリ

型: object

カテゴリ情報。

Show Source

displayName(optional): string

カテゴリの表示キー。

例: Asset Lifecycle
id(optional): integer(int32)

カテゴリのid。

例: 123456789
name(optional): string

カテゴリの名前。

例: ASSET_LIFECYCLE

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "format":"int32",
            "example":123456789,
            "description":"The id of the category."
        },
        "name":{
            "type":"string",
            "example":"ASSET_LIFECYCLE",
            "description":"The name of the category."
        },
        "displayName":{
            "type":"string",
            "example":"Asset Lifecycle",
            "description":"The display key of the category."
        }
    },
    "description":"Category Information."
}

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

型: object

RESTリンクおよび関連メタデータ。レスポンスがリンクを提供する場合(リソース自体への`self`リンクなど)、提供されたリンクには、このリンク構造で定義された1つ以上のプロパティが含まれます。

Show Source

href(optional): string

ターゲット・リソースのURI URI *RFC3986*またはURIテンプレート*RFC6570*。値がURIテンプレートに設定されている場合、`templated`プロパティを`true`に設定する必要があります。
mediaType(optional): string

リンク・ターゲット。メディア・タイプ。RFC 2046で定義され、リンク・ターゲットを記述します。
method(optional): string

ターゲットHTTPメソッドをリンクします。リンクのターゲットをリクエストするためのHTTPメソッド。* `none` - 有効なHTTPメソッド*'OPTIONS`がないことを示します - HTTP OPTIONS * `HEAD - HTTP HEAD * `GET` - HTTP GET * `POST` - HTTP POST * `PUT` - HTTP PUT * `PATCH` - HTTP PATCH * `DELETE` - HTTP DELETE
profile(optional): string

リンク・メタデータのロケーション。ターゲット・リソースを参照解除するときにリソースを指定するJSONスキーマなどのリソースのメタデータへのリンク。
rel(optional): string

リンク関係。リンクの詳細を取得するために使用できるリンク・リレーションの名前。
templated(optional): boolean

hrefテンプレートのリンク・フラグ。 `href`プロパティを指定するブール・フラグは、URIまたはURIテンプレートです。プロパティが存在しない場合、このプロパティは`false`と想定できます。

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "description":"Link relation. Name of the link relation that, in addition to the type property, can be used to retrieve link details."
        },
        "href":{
            "type":"string",
            "description":"The target resource URI. URI *RFC3986* or URI Template *RFC6570*. If the value is set to URI Template, then the `templated` property must be set to `true`."
        },
        "templated":{
            "type":"boolean",
            "description":"Link href template flag. Boolean flag that specifies the `href` property is a URI or URI Template. The property can be assumed to be `false` if the property is not present."
        },
        "mediaType":{
            "type":"string",
            "description":"Link target. Media type, as defined by RFC 2046, describing the link target."
        },
        "method":{
            "type":"string",
            "description":"Link target HTTP method. HTTP method for requesting the target of the link.  *  `none` - Indicates no valid HTTP method *  `OPTIONS` - HTTP OPTIONS *  `HEAD` - HTTP HEAD *  `GET` - HTTP GET *  `POST` - HTTP POST *  `PUT` - HTTP PUT *  `PATCH` - HTTP PATCH *  `DELETE` - HTTP DELETE"
        },
        "profile":{
            "type":"string",
            "description":"Link meta data location. Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource."
        }
    },
    "description":"REST link and related meta data.  If responses provide links (e.g. a `self` link to the resource itself) the links provided will include one or more of the properties defined on this link structure."
}

304レスポンス

Not Modified

ルート・スキーマ : 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"
    }
}

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"
    }
}

404レスポンス

Not Found

ルート・スキーマ : 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"
    }
}