Jump to

• Request
• Response

Identify a time card as favorite

post

/hcmRestApi/resources/11.13.18.05/timeRecordEventRequests/action/createFavorite

Identifies a time card as a favorite for easy copying of time card data. For example, marks the time card for the time card period June 1, 2019 -- June 7, 2019 as a favorite with the name Regular Worked Time.

Request

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/vnd.oracle.adf.action+json

Request Body - application/vnd.oracle.adf.action+json ()

Root Schema : schema

Type: object

Show Source

• favoriteName: string
  Name of the time card being identified as a favorite.
• timeRecordGroupId: string
  Identifier for the time card marked as a favorite.

{
    "type":"object",
    "properties":{
        "favoriteName":{
            "type":"string",
            "description":"Name of the time card being identified as a favorite.",
            "nullable":true
        },
        "timeRecordGroupId":{
            "type":"string",
            "description":"Identifier for the time card marked as a favorite.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.oracle.adf.actionresult+json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : schema

Type: object

Show Source

• result(required): string
  Result of the action identifying the time card as a favorite.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"string",
            "description":"Result of the action identifying the time card as a favorite."
        }
    },
    "additionalProperties":false
}

Back to Top