Jump to

• Request
• Response

Update an academic period date

patch

/fscmRestApi/resources/11.13.18.05/hedAcademicPeriods/{AcademicPeriodId}/child/periodDates/{AcademicPeriodDateId}

Request

Path Parameters

• AcademicPeriodDateId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• AcademicPeriodId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

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/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• DateCalculationSchemeCode: string
  Title: Date Calculation Scheme Code

  Maximum Length: 30

  Indicates the period date calculation scheme code. The scheme identifies the pivot date that's used when the date attribute is calculated.
• DateFactorNumber: integer (int32)
  Title: Date Factor

  Default Value: 0

  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
  Title: Date Rounding Code

  Maximum Length: 30

  Indicates the date rounding code when calculating the period date's value.
• DateTypeCode: string
  Title: Date Type Code

  Maximum Length: 30

  Default Value: ORA_DATE

  The date type code for an academic period date, such as date, date and time.
• EndDate: string (date-time)
  Title: End Date

  The date when the period attribute ends.
• PivotBasedFlag: boolean
  Title: Pivot Based

  Maximum Length: 1

  Default Value: false

  Indicates that this period date must be calculated. The default value is N.
• StartDate: string (date-time)
  Title: Start Date

  The date when the period attribute starts.
• TimezoneCode: string
  Title: Time Zone

  Maximum Length: 32

  Time zone code selected by a user when specifying a manual date time.

{
    "type":"object",
    "properties":{
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the period attribute starts.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "CalendarStartDate"
                ]
            }
        },
        "TimezoneCode":{
            "title":"Time Zone",
            "maxLength":32,
            "type":"string",
            "description":"Time zone code selected by a user when specifying a manual date time.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PivotBasedFlag":{
            "title":"Pivot Based",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates that this period date must be calculated. The default value is N.",
            "nullable":false,
            "default":false
        },
        "DateTypeCode":{
            "title":"Date Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The date type code for an academic period date, such as date, date and time.",
            "nullable":false,
            "default":"ORA_DATE",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DateCalculationSchemeCode":{
            "title":"Date Calculation Scheme Code",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the period date calculation scheme code. The scheme identifies the pivot date that's used when the date attribute is calculated.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DateFactorNumber":{
            "title":"Date Factor",
            "type":"integer",
            "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.",
            "format":"int32",
            "nullable":true,
            "default":0,
            "x-hints":{
                "precision":3
            }
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the period attribute ends.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "CalendarEndDate"
                ]
            }
        },
        "DateRoundingCode":{
            "title":"Date Rounding Code",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the date rounding code when calculating the period date's value.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• 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.

Body ()

Root Schema : hedAcademicPeriods-periodDates-item-response

Type: object

Show Source

• AcademicPeriodDateId: integer (int64)
  Title: Academic Period Date ID

  Read Only: true

  The unique identifier for an academic period date.
• DateCalculationSchemeCode: string
  Title: Date Calculation Scheme Code

  Maximum Length: 30

  Indicates the period date calculation scheme code. The scheme identifies the pivot date that's used when the date attribute is calculated.
• DateCalculationSchemeMeaning: string
  Title: Date Calculation Scheme Meaning

  Read Only: true

  Maximum Length: 80

  Indicates the period date calculation scheme meaning. The scheme identifies the pivot date that's used when the date attribute is calculated.
• DateFactorNumber: integer (int32)
  Title: Date Factor

  Default Value: 0

  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
  Title: Date Rounding Code

  Maximum Length: 30

  Indicates the date rounding code when calculating the period date's value.
• DateRoundingMeaning: string
  Title: Date Rounding Meaning

  Read Only: true

  Maximum Length: 80

  Indicates the date rounding type when calculating the period date's value.
• DateTypeCode: string
  Title: Date Type Code

  Maximum Length: 30

  Default Value: ORA_DATE

  The date type code for an academic period date, such as date, date and time.
• DateTypeMeaning: string
  Title: Date Type Meaning

  Read Only: true

  Maximum Length: 80

  The date type meaning for an academic period date, such as date, date and time.
• EndDate: string (date-time)
  Title: End Date

  The date when the period attribute ends.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PeriodAttributeCode: string
  Title: Period Attribute Code

  Maximum Length: 30

  The code of a period attribute.
• PeriodAttributeId: integer (int64)
  Title: Period Attribute ID

  The identifier of a period attribute.
• PeriodAttributeName: string
  Title: Period Attribute Name

  Read Only: true

  Maximum Length: 50

  The name of a period attribute.
• PivotBasedFlag: boolean
  Title: Pivot Based

  Maximum Length: 1

  Default Value: false

  Indicates that this period date must be calculated. The default value is N.
• StartDate: string (date-time)
  Title: Start Date

  The date when the period attribute starts.
• TimezoneCode: string
  Title: Time Zone

  Maximum Length: 32

  Time zone code selected by a user when specifying a manual date time.
• TimezoneName: string
  Title: Timezone Name

  Read Only: true

  Maximum Length: 80

  Time zone name selected by a user when specifying a manual date time.

{
    "type":"object",
    "properties":{
        "PeriodAttributeId":{
            "title":"Period Attribute ID",
            "type":"integer",
            "description":"The identifier of a period attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "PeriodAttributeCode"
                ]
            },
            "x-queryable":true
        },
        "TimezoneCode":{
            "title":"Time Zone",
            "maxLength":32,
            "type":"string",
            "description":"Time zone code selected by a user when specifying a manual date time.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PivotBasedFlag":{
            "title":"Pivot Based",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates that this period date must be calculated. The default value is N.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "DateCalculationSchemeCode":{
            "title":"Date Calculation Scheme Code",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the period date calculation scheme code. The scheme identifies the pivot date that's used when the date attribute is calculated.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DateTypeMeaning":{
            "title":"Date Type Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The date type meaning for an academic period date, such as date, date and time.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DateRoundingMeaning":{
            "title":"Date Rounding Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Indicates the date rounding type when calculating the period date's value.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PeriodAttributeCode":{
            "title":"Period Attribute Code",
            "maxLength":30,
            "type":"string",
            "description":"The code of a period attribute.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TimezoneName":{
            "title":"Timezone Name",
            "maxLength":80,
            "type":"string",
            "description":"Time zone name selected by a user when specifying a manual date time.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the period attribute ends.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "CalendarEndDate"
                ]
            },
            "x-queryable":true
        },
        "DateCalculationSchemeMeaning":{
            "title":"Date Calculation Scheme Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Indicates the period date calculation scheme meaning. The scheme identifies the pivot date that's used when the date attribute is calculated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PeriodAttributeName":{
            "title":"Period Attribute Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of a period attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DateRoundingCode":{
            "title":"Date Rounding Code",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the date rounding code when calculating the period date's value.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the period attribute starts.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "CalendarStartDate"
                ]
            },
            "x-queryable":true
        },
        "AcademicPeriodDateId":{
            "title":"Academic Period Date ID",
            "type":"integer",
            "description":"The unique identifier for an academic period date.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "DateTypeCode":{
            "title":"Date Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The date type code for an academic period date, such as date, date and time.",
            "nullable":false,
            "default":"ORA_DATE",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DateFactorNumber":{
            "title":"Date Factor",
            "type":"integer",
            "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.",
            "format":"int32",
            "nullable":true,
            "default":0,
            "x-hints":{
                "precision":3
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

dateCalculationSchemeLOV

Operation: /fscmRestApi/resources/11.13.18.05/herLookups

Parameters:

• finder: ByLookupTypeFinder%3BLookupType%3DORA_HER_DATE_CALC_SCHEME_CODE%2CLookupCode%3D{DateCalculationSchemeCode}

List of values for date calculation schemes

dateRoundingsLOV

Operation: /fscmRestApi/resources/11.13.18.05/herLookups

Parameters:

• finder: ByLookupTypeFinder%3BLookupType%3DORA_HER_DATE_ROUNDING_CODE%2CLookupCode%3D{DateRoundingCode}

List of values for date rounding methods

dateTypesLOV

Operation: /fscmRestApi/resources/11.13.18.05/herLookups

Parameters:

• finder: ByLookupTypeFinder%3BLookupType%3DORA_HER_ACAD_PERIOD_DTTM_TYPE%2CLookupCode%3D{DateTypeCode}

List of values for period date types

periodAttributesLOV

Operation: /fscmRestApi/resources/11.13.18.05/hedPeriodAttributesLOV

List of values for period attributes

timezoneCodesLOV

Operation: /fscmRestApi/resources/11.13.18.05/hedTimezones

List of values for time zone codes

Back to Top