Jump to

• Request
• Response

Calculate pivot date

post

/fscmRestApi/resources/11.13.18.05/hedAcademicPeriods/action/calculatePivotDate

Creates pivot date based on specified parameters.

Request

Header Parameters

• Metadata-Context: string
  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: string
  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

• DateFactorNumber: number
  Indicates the required number of days to adjustment before or after the pivot date. Before the date is a negative number and after is a positive number.
• DateRoundingCode: string
  Indicates the date rounding type code when calculating the period date's value. The code must be from the lookup type ORA_HER_DATE_ROUNDING_CODE.
• PivotDate: string (date-time)
  The pivot date that's used when calculating a period attribute date.
• TimeZoneCode: string
  Indicates the time zone code that's used for the rounding logic. If time zone isn't provided, UTC time zone is used.

{
    "type":"object",
    "properties":{
        "TimeZoneCode":{
            "type":"string",
            "description":"Indicates the time zone code that's used for the rounding logic. If time zone isn't provided, UTC time zone is used.",
            "nullable":true
        },
        "PivotDate":{
            "type":"string",
            "description":"The pivot date that's used when calculating a period attribute date.",
            "format":"date-time",
            "nullable":true
        },
        "DateFactorNumber":{
            "type":"number",
            "description":"Indicates the required number of days to adjustment before or after the pivot date. Before the date is a negative number and after is a positive number.",
            "nullable":true
        },
        "DateRoundingCode":{
            "type":"string",
            "description":"Indicates the date rounding type code when calculating the period date's value. The code must be from the lookup type ORA_HER_DATE_ROUNDING_CODE.",
            "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

  The date that results from the calculation. This value is provided in the ReturnDate attribute of the response object.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"string",
                "format":"date-time"
            },
            "description":"The date that results from the calculation. This value is provided in the ReturnDate attribute of the response object."
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: object

Additional Properties Allowed

Show Source

• string(date-time)

{
    "type":"object",
    "additionalProperties":{
        "type":"string",
        "format":"date-time"
    },
    "description":"The date that results from the calculation. This value is provided in the ReturnDate attribute of the response object."
}

The date that results from the calculation. This value is provided in the ReturnDate attribute of the response object.

Back to Top