Jump to

• Request
• Response

Create all attributes

post

/fscmRestApi/resources/11.13.18.05/hedPeriodAttributes

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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ActiveFlag: boolean
  Title: Active

  Maximum Length: 1

  Default Value: true

  Indicates whether the period attribute is active. The default value is true.
• DateCalculationSchemeCode: string
  Title: Date Calculation Scheme Code

  Maximum Length: 30

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

  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.
• DateRoundingCode: string
  Title: Date Rounding Code

  Maximum Length: 30

  Indicates the rounding preference when calculating the date attribute's value.
• DefaultAttributeDate: string (date-time)
  Title: Default Attribute Date

  Default date or date time value for the attribute.
• DefaultAttributeDateTwo: string (date-time)
  Title: Second Default Attribute Date

  Second default date or date time value for the attribute. This is used to store the end date for a period attribute of range type.
• PeriodAttributeCode(required): string
  Title: Period Attribute Code

  Maximum Length: 30

  The code of a period attribute.
• PeriodAttributeName(required): string
  Title: Period Attribute Name

  Maximum Length: 50

  The name of a period attribute.
• PeriodAttributeTypeCode: string
  Title: Date Type

  Maximum Length: 30

  Default Value: ORA_DATE

  The date type code of a period attribute, such as DATE, DTTM.
• PivotBasedFlag: boolean
  Title: Pivot Based

  Maximum Length: 1

  Default Value: false

  Indicates that this date time attribute is calculated based on the pivot date. The default value is false.
• tagAssignments: array Period Attribute Tags
  Title: Period Attribute Tags

  The tag assignments resource is used to manage tag assignments of period attributes.
• TimezoneCode: string
  Title: Time Zone Code

  Maximum Length: 32

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

{
    "required":[
        "PeriodAttributeCode",
        "PeriodAttributeName"
    ],
    "type":"object",
    "properties":{
        "tagAssignments":{
            "title":"Period Attribute Tags",
            "type":"array",
            "description":"The tag assignments resource is used to manage tag assignments of period attributes.",
            "items":{
                "$ref":"#/components/schemas/hedPeriodAttributes-tagAssignments-item-post-request"
            }
        },
        "TimezoneCode":{
            "title":"Time Zone Code",
            "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 date time attribute is calculated based on the pivot date. The default value is false.",
            "nullable":false,
            "default":false
        },
        "DefaultAttributeDateTwo":{
            "title":"Second Default Attribute Date",
            "type":"string",
            "description":"Second default date or date time value for the attribute. This is used to store the end date for a period attribute of range type.",
            "format":"date-time",
            "nullable":true
        },
        "DateCalculationSchemeCode":{
            "title":"Date Calculation Scheme Code",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the date attribute calculation scheme code. The scheme identifies the pivot date that's used when the date attribute is calculated.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PeriodAttributeTypeCode":{
            "title":"Date Type",
            "maxLength":"30",
            "type":"string",
            "description":"The date type code of a period attribute, such as DATE, DTTM.",
            "nullable":false,
            "default":"ORA_DATE",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PeriodAttributeCode":{
            "title":"Period Attribute Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code of a period attribute.",
            "nullable":false
        },
        "DateFactorNumber":{
            "title":"Days Adjusted By",
            "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.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"3"
            }
        },
        "DefaultAttributeDate":{
            "title":"Default Attribute Date",
            "type":"string",
            "description":"Default date or date time value for the attribute.",
            "format":"date-time",
            "nullable":true
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the period attribute is active. The default value is true.",
            "nullable":false,
            "default":true
        },
        "PeriodAttributeName":{
            "title":"Period Attribute Name",
            "maxLength":"50",
            "type":"string",
            "description":"The name of a period attribute.",
            "nullable":false
        },
        "DateRoundingCode":{
            "title":"Date Rounding Code",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the rounding preference when calculating the date attribute's value.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

Nested Schema : Period Attribute Tags

Type: array

Title: Period Attribute Tags

The tag assignments resource is used to manage tag assignments of period attributes.

Show Source

• Array of: object schema

{
    "title":"Period Attribute Tags",
    "type":"array",
    "description":"The tag assignments resource is used to manage tag assignments of period attributes.",
    "items":{
        "$ref":"#/components/schemas/hedPeriodAttributes-tagAssignments-item-post-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• TagCode: string
  Title: Tag Code

  Maximum Length: 30

  The code of the tag.
• TagId: integer (int64)
  Title: Tag Identifier

  The identifier of the tag.

{
    "type":"object",
    "properties":{
        "TagId":{
            "title":"Tag Identifier",
            "type":"integer",
            "description":"The identifier of the tag.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "TagCode":{
            "title":"Tag Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code of the tag.",
            "nullable":false,
            "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 : hedPeriodAttributes-item-response

Type: object

Show Source

• ActiveFlag: boolean
  Title: Active

  Maximum Length: 1

  Default Value: true

  Indicates whether the period attribute is active. The default value is true.
• DateCalculationSchemeCode: string
  Title: Date Calculation Scheme Code

  Maximum Length: 30

  Indicates the date attribute 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

  The date attribute calculation scheme meaning of a period attribute.
• DateFactorNumber: integer (int32)
  Title: Days Adjusted By

  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.
• DateRoundingCode: string
  Title: Date Rounding Code

  Maximum Length: 30

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

  Read Only: true

  Maximum Length: 80

  The rounding preference meaning of a period attribute.
• DefaultAttributeDate: string (date-time)
  Title: Default Attribute Date

  Default date or date time value for the attribute.
• DefaultAttributeDateTwo: string (date-time)
  Title: Second Default Attribute Date

  Second default date or date time value for the attribute. This is used to store the end date for a period attribute of range type.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date and time when the period attribute was last updated.
• 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

  Read Only: true

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

  Maximum Length: 50

  The name of a period attribute.
• PeriodAttributeTypeCode: string
  Title: Date Type

  Maximum Length: 30

  Default Value: ORA_DATE

  The date type code of a period attribute, such as DATE, DTTM.
• PeriodAttributeTypeMeaning: string
  Title: Date Type Meaning

  Read Only: true

  Maximum Length: 80

  The date type meaning of a period attribute.
• PivotBasedFlag: boolean
  Title: Pivot Based

  Maximum Length: 1

  Default Value: false

  Indicates that this date time attribute is calculated based on the pivot date. The default value is false.
• PredefinedFlag: boolean
  Title: Predefined

  Read Only: true

  Maximum Length: 1

  Indicates whether the period attribute is predefined. The default value is false.
• tagAssignments: array Period Attribute Tags
  Title: Period Attribute Tags

  The tag assignments resource is used to manage tag assignments of period attributes.
• TimezoneCode: string
  Title: Time Zone Code

  Maximum Length: 32

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

  Read Only: true

  Maximum Length: 80

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

{
    "type":"object",
    "properties":{
        "tagAssignments":{
            "title":"Period Attribute Tags",
            "type":"array",
            "description":"The tag assignments resource is used to manage tag assignments of period attributes.",
            "items":{
                "$ref":"#/components/schemas/hedPeriodAttributes-tagAssignments-item-response"
            }
        },
        "PeriodAttributeId":{
            "title":"Period Attribute ID",
            "type":"integer",
            "description":"The unique identifier of a period attribute.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "TimezoneCode":{
            "title":"Time Zone Code",
            "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 date time attribute is calculated based on the pivot date. The default value is false.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "PredefinedFlag":{
            "title":"Predefined",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the period attribute is predefined. The default value is false.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "SeedDataLock"
                ]
            },
            "x-queryable":true
        },
        "DateCalculationSchemeCode":{
            "title":"Date Calculation Scheme Code",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the date attribute 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
        },
        "DateRoundingMeaning":{
            "title":"Date Rounding Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"The rounding preference meaning of a period attribute.",
            "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-queryable":true
        },
        "TimezoneName":{
            "title":"Time Zone",
            "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
        },
        "DefaultAttributeDate":{
            "title":"Default Attribute Date",
            "type":"string",
            "description":"Default date or date time value for the attribute.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the period attribute is active. The default value is true.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "DateCalculationSchemeMeaning":{
            "title":"Date Calculation Scheme Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"The date attribute calculation scheme meaning of a period attribute.",
            "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,
            "x-queryable":true
        },
        "DateRoundingCode":{
            "title":"Date Rounding Code",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the rounding preference when calculating the date attribute's value.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PeriodAttributeTypeMeaning":{
            "title":"Date Type Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"The date type meaning of a period attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DefaultAttributeDateTwo":{
            "title":"Second Default Attribute Date",
            "type":"string",
            "description":"Second default date or date time value for the attribute. This is used to store the end date for a period attribute of range type.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "PeriodAttributeTypeCode":{
            "title":"Date Type",
            "maxLength":"30",
            "type":"string",
            "description":"The date type code of a period attribute, such as DATE, DTTM.",
            "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":"Days Adjusted By",
            "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.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"3"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date and time when the period attribute was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "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 : Period Attribute Tags

Type: array

Title: Period Attribute Tags

The tag assignments resource is used to manage tag assignments of period attributes.

Show Source

• Array of: object hedPeriodAttributes-tagAssignments-item-response

{
    "title":"Period Attribute Tags",
    "type":"array",
    "description":"The tag assignments resource is used to manage tag assignments of period attributes.",
    "items":{
        "$ref":"#/components/schemas/hedPeriodAttributes-tagAssignments-item-response"
    }
}

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."
        }
    }
}

Nested Schema : hedPeriodAttributes-tagAssignments-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• TagAssignmentId: integer (int64)
  Title: Tag Assignment ID

  Read Only: true

  The identifier of the tag assignment.
• TagCode: string
  Title: Tag Code

  Maximum Length: 30

  The code of the tag.
• TagId: integer (int64)
  Title: Tag Identifier

  The identifier of the tag.
• TagName: string
  Title: Tag Name

  Read Only: true

  Maximum Length: 64

  The name of the tag.

{
    "type":"object",
    "properties":{
        "TagId":{
            "title":"Tag Identifier",
            "type":"integer",
            "description":"The identifier of the tag.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TagAssignmentId":{
            "title":"Tag Assignment ID",
            "type":"integer",
            "description":"The identifier of the tag assignment.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "TagCode":{
            "title":"Tag Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code of the tag.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TagName":{
            "title":"Tag Name",
            "maxLength":"64",
            "type":"string",
            "description":"The name of the tag.",
            "nullable":false,
            "readOnly":true,
            "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"
    }
}

Links

dateCalculationSchemeLOV

Operation: /fscmRestApi/resources/11.13.18.05/herLookups

Parameters:

• finder: ByLookupTypeFinder%3BLookupCode%3D{DateCalculationSchemeCode}%2CLookupType%3DORA_HER_DATE_CALC_SCHEME_CODE

The following properties are defined on the LOV link relation:

• Source Attribute: DateCalculationSchemeCode; Target Attribute: LookupCode
• Display Attribute: Meaning

dateRoundingsLOV

Operation: /fscmRestApi/resources/11.13.18.05/herLookups

Parameters:

• finder: ByLookupTypeFinder%3BLookupCode%3D{DateRoundingCode}%2CLookupType%3DORA_HER_DATE_ROUNDING_CODE

The following properties are defined on the LOV link relation:

• Source Attribute: DateRoundingCode; Target Attribute: LookupCode
• Display Attribute: Meaning

periodAttributeTypesLOV

Operation: /fscmRestApi/resources/11.13.18.05/herLookups

Parameters:

• finder: ByLookupTypeFinder%3BLookupCode%3D{PeriodAttributeTypeCode}%2CLookupType%3DORA_HER_ACAD_PERIOD_DTTM_TYPE

The following properties are defined on the LOV link relation:

• Source Attribute: PeriodAttributeTypeCode; Target Attribute: LookupCode
• Display Attribute: Meaning

tagAssignments

Operation: /fscmRestApi/resources/11.13.18.05/hedPeriodAttributes/{PeriodAttributeId}/child/tagAssignments

Parameters:

• PeriodAttributeId: $request.path.PeriodAttributeId

The tag assignments resource is used to manage tag assignments of period attributes.

timezoneCodesLOV

Operation: /fscmRestApi/resources/11.13.18.05/hedTimezones

The following properties are defined on the LOV link relation:

• Source Attribute: TimezoneCode; Target Attribute: TimezoneCode
• Display Attribute: Name

Back to Top