Jump to

• Request
• Response

Add a discovery tile

post

/hcmRestApi/resources/11.13.18.05/recruitingCESiteTileDetails/action/addDiscoveryTile

Adds a discovery tile with given details.

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

• isVisibleFlag: string
  Visible flag for adding a discovery tile used in the discover page.
• linkDescription: string
  Link description for adding a discovery tile.
• linkOrder: number
  Link order for adding a discovery tile.
• linkText: string
  Link text for adding a discovery tile.
• linkURL: string
  Link URL for adding a discovery tile.
• siteNumber: string
  Site number for adding a discovery tile.
• thumbnailURL: string
  Thumbnail URL for adding a discovery tile.

{
    "type":"object",
    "properties":{
        "isVisibleFlag":{
            "type":"string",
            "description":"Visible flag for adding a discovery tile used in the discover page.",
            "nullable":true
        },
        "linkDescription":{
            "type":"string",
            "description":"Link description for adding a discovery tile.",
            "nullable":true
        },
        "linkOrder":{
            "type":"number",
            "description":"Link order for adding a discovery tile.",
            "nullable":true
        },
        "linkURL":{
            "type":"string",
            "description":"Link URL for adding a discovery tile.",
            "nullable":true
        },
        "siteNumber":{
            "type":"string",
            "description":"Site number for adding a discovery tile.",
            "nullable":true
        },
        "linkText":{
            "type":"string",
            "description":"Link text for adding a discovery tile.",
            "nullable":true
        },
        "thumbnailURL":{
            "type":"string",
            "description":"Thumbnail URL for adding a discovery tile.",
            "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): object result
  Additional Properties Allowed: additionalProperties

  Return value for adding a discovery tile.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"Return value for adding a discovery tile."
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"Return value for adding a discovery tile."
}

Return value for adding a discovery tile.

Back to Top