Oracle Fusionサービスでのナレッジ管理のREST API

記事ステータスの更新

put

/km/api/v1/articleStatus/{id}

このメソッドは、指定された一意の識別子パラメータでArticleStatusオブジェクトを更新します。

ArticleStatusオブジェクトは、複数の言語をサポートしています。 ArticleStatusオブジェクトを更新する場合は、目的のロケールでArticleStatusオブジェクトのローカリゼーションを作成または更新するために、LocalizedAttributeオブジェクトのリストを指定する必要があります。

URIの例

このメソッドのURIの例を次に示します:

http://<IM_REST_API_HOST>/km/api/latest/articleStatus/{id}
リクエストは、指定された一意の識別子パラメータでArticleStatusオブジェクトを更新します。

レスポンス・エラー

このメソッドの考えられるエラー・レスポンスは次のとおりです:

OK-SEC0001
このエラーは、ユーザーがArticeStatusオブジェクトを更新できない場合に発生します。
OKDOM-GEN0001
このエラーは、指定された一意の識別子パラメータを持つArticleStatusオブジェクトが見つからない場合に発生します。
OK-GEN0005
このエラーは、名前の値がリクエストで指定されていない場合に発生します。
OKDOM-GEN0004
このエラーは、リクエストに指定された名前値がすでに存在する場合に発生します。
OKDOM-GEN0003
このエラーは、リクエストに指定された参照キー値がすでに存在する場合に発生します。
OK-GEN0024
このエラーは、リクエストで指定された参照キー値が無効である場合に発生します。
OK-GEN0016
このエラーは、リクエストでLocalizedAttributes名またはロケール値が指定されていない場合に発生します。また、このエラーは、リクエストで指定されたLocalizedAttributesロケール値が無効な場合にも発生します。
$ERROR.ArticleStatus.STATUS_CANNOT_BE_DEACTIVATED$
このエラーは、ArticleStatusが記事に現在割り当てられており、アクティブ・フラグがリクエストでfalseとして指定されている場合に発生します。

リクエスト

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

application/json
application/xml

パス・パラメータ

id: string

更新するオブジェクトの一意の識別子。

更新するオブジェクト。

ルート・スキーマ : ArticleStatus

タイプ: object

タイトル: ArticleStatus

ソースを表示

active(optional): boolean

このパラメータを使用して、ArticleStatusオブジェクトがシステムでアクティブまたは非アクティブである場合に、それらをフィルタできます。
dateAdded(optional): string(date-time)

ArticleStatusオブジェクトが作成または追加された日付。
dateModified(optional): string(date-time)

ArticleStatusオブジェクトが最後に変更された日付。
links(optional): array links
localizedAttributes(optional): array localizedAttributes

様々なロケールでのこのArticleStatusのLocalizedAttributesのリスト
name(optional): string

ArticleStatusオブジェクトのローカライズされた名前。名前フィールドはソートにのみ使用できます。
recordId(optional): string

ArticleStatusオブジェクトの一意の識別子。
referenceKey(optional): string

ArticleStatusオブジェクトの参照キー。
ArticleStatusオブジェクトは、複数の言語をサポートしています。このフィールドを使用して、すべての言語の関連オブジェクトを識別できます。

{
    "title":"ArticleStatus",
    "properties":{
        "recordId":{
            "description":"<p>The unique identifier of the ArticleStatus object.</p>",
            "type":"string"
        },
        "localizedAttributes":{
            "items":{
                "$ref":"#/definitions/LocalizedAttributes"
            },
            "description":"List of LocalizedAttributes of this ArticleStatus in various Locales",
            "type":"array"
        },
        "dateModified":{
            "description":"<p>The date when the ArticleStatus object was last modified.</p>",
            "format":"date-time",
            "type":"string"
        },
        "referenceKey":{
            "description":"<p>The reference key for the ArticleStatus object. <br/>ArticleStatus objects support multiple languages. This field can be used to identify the associated objects for all languages.</p>",
            "type":"string"
        },
        "name":{
            "description":"<p>The localized name of the ArticleStatus object. The name field can only be used for sorting.</p>",
            "type":"string"
        },
        "dateAdded":{
            "description":"<p>The date when the ArticleStatus object was created or added.</p>",
            "format":"date-time",
            "type":"string"
        },
        "active":{
            "description":"<p>This parameter can be used to filter ArticleStatus objects if they are active or inactive in the system.</p>",
            "type":"boolean"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        }
    }
}

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

タイプ: array

ソースを表示

Array of: object instanceLink

JSONインスタンス表現に表示される可能性があるリンク記述オブジェクトを記述するMetadata。

{
    "items":{
        "$ref":"#/definitions/instanceLink"
    },
    "type":"array"
}

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

タイプ: array

様々なロケールでのこのArticleStatusのLocalizedAttributesのリスト

ソースを表示

Array of: object LocalizedAttributes

タイトル: LocalizedAttributes

{
    "items":{
        "$ref":"#/definitions/LocalizedAttributes"
    },
    "description":"List of LocalizedAttributes of this ArticleStatus in various Locales",
    "type":"array"
}

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

タイプ: object

JSONインスタンス表現に表示される可能性があるリンク記述オブジェクトを記述するMetadata。

ソースを表示

href: string

URI [RFC3986]またはURIテンプレート[RFC6570]。値がURI Templateに設定されている場合、「templated」プロパティをtrueに設定する必要があります。
mediaType(optional): string

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

リンクのターゲットをリクエストするためのHTTPメソッド。
profile(optional): string

ターゲット・リソースの参照解除時に予期されるリソースを記述する、JSONスキーマなどのリソースのメタデータへのリンク。
rel: string

リンクの詳細を取得するためにタイプ・プロパティに加えて使用できるリンク関係の名前。たとえば、hrefやprofileです。
templated(optional): boolean

hrefプロパティがURIまたはURIテンプレートであることを指定するブール・フラグ。プロパティがURIテンプレートの場合は、この値をtrueに設定します。デフォルトでは、この値はfalseです。

{
    "description":"Metadata describing link description objects that MAY appear in the JSON instance representation.",
    "properties":{
        "templated":{
            "description":"Boolean flag that specifies that \"href\" property is a URI or URI Template. If the property is a URI template, set this value to true. By default, this value is false.",
            "type":"boolean"
        },
        "method":{
            "description":"HTTP method for requesting the target of the link.",
            "type":"string"
        },
        "rel":{
            "description":"Name of the link relation that, in addition to the type property, can be used to retrieve link details. For example, href or profile.",
            "type":"string"
        },
        "href":{
            "description":"URI [RFC3986] or URI Template [RFC6570]. If the value is set to URI Template, then the \"templated\" property must be set to true.",
            "type":"string"
        },
        "mediaType":{
            "description":"Media type, as defined by RFC 2046, describing the link target.",
            "type":"string"
        },
        "profile":{
            "description":"Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource..",
            "type":"string"
        }
    },
    "required":[
        "href",
        "rel"
    ],
    "type":"object"
}

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

タイプ: object

タイトル: LocalizedAttributes

ソースを表示

description(optional): string

上のロケールでローカライズされた説明
localeId(optional): string

ロケールのRecordId - 通常、これはlocaleCode (en_USなど)であり、実際のGUIDではありません。
name(optional): string

上のロケールでローカライズされた名前

{
    "title":"LocalizedAttributes",
    "properties":{
        "localeId":{
            "description":"RecordId of the Locale - generally this is the localeCode (like en_US) and NOT a real GUID.",
            "type":"string"
        },
        "description":{
            "description":"Localized description in the above Locale",
            "type":"string"
        },
        "name":{
            "description":"Localized Name in the above Locale",
            "type":"string"
        }
    }
}

トップに戻る

レスポンス

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

application/json
application/xml

200 レスポンス

「OK」をクリックします。

ルート・スキーマ : ArticleStatus

タイプ: object

タイトル: ArticleStatus

ソースを表示

active(optional): boolean

このパラメータを使用して、ArticleStatusオブジェクトがシステムでアクティブまたは非アクティブである場合に、それらをフィルタできます。
dateAdded(optional): string(date-time)

ArticleStatusオブジェクトが作成または追加された日付。
dateModified(optional): string(date-time)

ArticleStatusオブジェクトが最後に変更された日付。
links(optional): array links
localizedAttributes(optional): array localizedAttributes

様々なロケールでのこのArticleStatusのLocalizedAttributesのリスト
name(optional): string

ArticleStatusオブジェクトのローカライズされた名前。名前フィールドはソートにのみ使用できます。
recordId(optional): string

ArticleStatusオブジェクトの一意の識別子。
referenceKey(optional): string

ArticleStatusオブジェクトの参照キー。
ArticleStatusオブジェクトは、複数の言語をサポートしています。このフィールドを使用して、すべての言語の関連オブジェクトを識別できます。

{
    "title":"ArticleStatus",
    "properties":{
        "recordId":{
            "description":"<p>The unique identifier of the ArticleStatus object.</p>",
            "type":"string"
        },
        "localizedAttributes":{
            "items":{
                "$ref":"#/definitions/LocalizedAttributes"
            },
            "description":"List of LocalizedAttributes of this ArticleStatus in various Locales",
            "type":"array"
        },
        "dateModified":{
            "description":"<p>The date when the ArticleStatus object was last modified.</p>",
            "format":"date-time",
            "type":"string"
        },
        "referenceKey":{
            "description":"<p>The reference key for the ArticleStatus object. <br/>ArticleStatus objects support multiple languages. This field can be used to identify the associated objects for all languages.</p>",
            "type":"string"
        },
        "name":{
            "description":"<p>The localized name of the ArticleStatus object. The name field can only be used for sorting.</p>",
            "type":"string"
        },
        "dateAdded":{
            "description":"<p>The date when the ArticleStatus object was created or added.</p>",
            "format":"date-time",
            "type":"string"
        },
        "active":{
            "description":"<p>This parameter can be used to filter ArticleStatus objects if they are active or inactive in the system.</p>",
            "type":"boolean"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        }
    }
}

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

タイプ: array

ソースを表示

Array of: object instanceLink

JSONインスタンス表現に表示される可能性があるリンク記述オブジェクトを記述するMetadata。

{
    "items":{
        "$ref":"#/definitions/instanceLink"
    },
    "type":"array"
}

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

タイプ: array

様々なロケールでのこのArticleStatusのLocalizedAttributesのリスト

ソースを表示

Array of: object LocalizedAttributes

タイトル: LocalizedAttributes

{
    "items":{
        "$ref":"#/definitions/LocalizedAttributes"
    },
    "description":"List of LocalizedAttributes of this ArticleStatus in various Locales",
    "type":"array"
}

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

タイプ: object

JSONインスタンス表現に表示される可能性があるリンク記述オブジェクトを記述するMetadata。

ソースを表示

href: string

URI [RFC3986]またはURIテンプレート[RFC6570]。値がURI Templateに設定されている場合、「templated」プロパティをtrueに設定する必要があります。
mediaType(optional): string

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

リンクのターゲットをリクエストするためのHTTPメソッド。
profile(optional): string

ターゲット・リソースの参照解除時に予期されるリソースを記述する、JSONスキーマなどのリソースのメタデータへのリンク。
rel: string

リンクの詳細を取得するためにタイプ・プロパティに加えて使用できるリンク関係の名前。たとえば、hrefやprofileです。
templated(optional): boolean

hrefプロパティがURIまたはURIテンプレートであることを指定するブール・フラグ。プロパティがURIテンプレートの場合は、この値をtrueに設定します。デフォルトでは、この値はfalseです。

{
    "description":"Metadata describing link description objects that MAY appear in the JSON instance representation.",
    "properties":{
        "templated":{
            "description":"Boolean flag that specifies that \"href\" property is a URI or URI Template. If the property is a URI template, set this value to true. By default, this value is false.",
            "type":"boolean"
        },
        "method":{
            "description":"HTTP method for requesting the target of the link.",
            "type":"string"
        },
        "rel":{
            "description":"Name of the link relation that, in addition to the type property, can be used to retrieve link details. For example, href or profile.",
            "type":"string"
        },
        "href":{
            "description":"URI [RFC3986] or URI Template [RFC6570]. If the value is set to URI Template, then the \"templated\" property must be set to true.",
            "type":"string"
        },
        "mediaType":{
            "description":"Media type, as defined by RFC 2046, describing the link target.",
            "type":"string"
        },
        "profile":{
            "description":"Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource..",
            "type":"string"
        }
    },
    "required":[
        "href",
        "rel"
    ],
    "type":"object"
}

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

タイプ: object

タイトル: LocalizedAttributes

ソースを表示

description(optional): string

上のロケールでローカライズされた説明
localeId(optional): string

ロケールのRecordId - 通常、これはlocaleCode (en_USなど)であり、実際のGUIDではありません。
name(optional): string

上のロケールでローカライズされた名前

{
    "title":"LocalizedAttributes",
    "properties":{
        "localeId":{
            "description":"RecordId of the Locale - generally this is the localeCode (like en_US) and NOT a real GUID.",
            "type":"string"
        },
        "description":{
            "description":"Localized description in the above Locale",
            "type":"string"
        },
        "name":{
            "description":"Localized Name in the above Locale",
            "type":"string"
        }
    }
}

トップに戻る

例

次の例は、ArticleStatusオブジェクトを更新する方法を示しています:

curl -X PUT "https://<IM_REST_API_HOST>/km/api/latest/articleStatus/{id}" -u "<username:password>" -H "Accept: application/json" -H "Content-Type: application/json" -d "@<FilePath/RequestBody.json>"

リクエスト本文の例

次の例は、JSON形式のリクエスト本文のコンテンツを示しています:

{
  "recordId": "A7B7C73852354172834E259C7591F0FB",
  "referenceKey": "USER1",
  "name": "user1",
  "dateAdded": "2019-03-22T10:58:46+0000",
  "dateModified": "2019-03-22T10:58:46+0000",
  "active": true,
  "localizedAttributes": [
    {
      "localeId": "en_US",
      "name": "user1"
    },
    {
      "localeId": "ko_KR",
      "name": "user1"
    }
  ]
}

応答本文の例

次に、JSON形式のレスポンス本文の例を示します。

{
  "recordId": "A7B7C73852354172834E259C7591F0FB",
  "referenceKey": "USER1",
  "name": "user1",
  "links": [
    {
      "rel": "canonical",
      "href": "https://<IM_REST_API_HOST>/km/api/latest/articleStatus/A7B7C73852354172834E259C7591F0FB",
      "mediaType": "application/json, application/xml",
      "method": "GET"
    },
    {
      "rel": "collection",
      "href": "https://<IM_REST_API_HOST>/km/api/latest/articleStatus",
      "mediaType": "application/json, application/xml",
      "method": "GET",
      "profile": "https://<IM_REST_API_HOST>/km/api/latest/metadata-catalog/articleStatus"
    }
  ],
  "dateAdded": "2019-03-22T10:58:46+0000",
  "dateModified": "2019-03-22T10:58:46+0000",
  "active": true,
  "localizedAttributes": [
    {
      "localeId": "en_US",
      "name": "user1"
    },
    {
      "localeId": "ko_KR",
      "name": "user1"
    }
  ]
}

「トップに戻る」