Jump to

• Request
• Response
• Examples

Update subscription schedule

patch

/km/api/v1/users/{id}/subscriptionSchedule

This service will update subscription schedule of user with passed in schedule.

This service will update subscription schedule of user with passed-in schedule value.

Valid values for this parameter are:

• 0 indicates None
• 1 indicates Immediately
• 2 indicates Daily
• 4 indicates Weekly

Response Errors

The possible errors for this method are as follows:

• OKDOM-GEN0001 - This error occurs when the specified id parameter is invalid.
• OKDOM-GEN0006 - This error occurs when you specify any invalid value for the subscription schedule.
• OKDOM-USER0025 - This error occurs when the specified user does not have email.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• id: string
  The user identifier

Body ()

The subscription schedule to be updated

Root Schema : SubscriptionSchedule

Type: object

Title: SubscriptionSchedule

Show Source

• schedule(optional): integer
  SubscriptionSchedule of the SubscriptionSchedule object

{
    "title":"SubscriptionSchedule",
    "properties":{
        "schedule":{
            "type":"integer",
            "description":"SubscriptionSchedule of the SubscriptionSchedule object"
        }
    }
}

Back to Top

Response

204 Response

No Content.

Back to Top

Examples

cURL Command

The following example shows how to update subscription schedule of user with the passed in schedule by submitting a Patch request on the REST resource using cURL.

curl -X "POST" "http://<IM_REST_API_HOST>/km/api/latest/users/{id}/subscriptionSchedule"

Example of Request Header

The following shows an example of the request header.

-H "kmauthtoken: {\"siteName\":\"ORACLE_KNOWLEDGE\",\"integrationUserToken\":\"\"+eCJYkxKwj5HUaIiJYun0/TpatwT1LmtcsF05W33xnEojifV/AsLDj9RpN0lKuorTMNKeSE1tgC7svVL+BzntqDON4KiM1HFlpxvXEUCB0P2w0Xrs75McygqxdVaDSE9",\"userToken\":\"UoyWTKRG4RpyJCH4Wqjzht2iYUrsDdk5ir+3IpwEkxcwajJkGR9OGSQBTANQVGW0iVT9MFeDzqL+RYdgfzGSK+h5QzDFIDM+rDLgdKeEE19ljWFm3zMCF+kgYp/dJ/Yq5V7Re+aDXqHg6YkHfvprFA==\"}" \
-H "Accept: application/json"

Example of Request Body

The following example shows the contents of the request body in JSON format, including <additoinal information>:

{ 
    "schedule" : "SCHEDULE_VALUE"
}

Back to Top