Jump to

• Request
• Response

Update an academic period sequence

patch

/fscmRestApi/resources/11.13.18.05/academicPeriodSequences/{PeriodSequenceHeaderId}

Request

Path Parameters

• PeriodSequenceHeaderId(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:
  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/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• Description: string
  Title: Description

  Maximum Length: 240

  The description of an academic period sequence.
• levelOnePeriods: array Level One Academic Periods
  Title: Level One Academic Periods

  The level one academic periods resource is a child resource of the academic period sequence resource and provides an ordered sequence of academic periods in the first level of the hierarchy.
• PeriodSequenceHeaderId: integer (int64)
  Title: Sequence Header ID

  The unique identifier for an academic period sequence.
• periodSequenceOwners: array Academic Period Sequence Owners
  Title: Academic Period Sequence Owners

  The academic period sequence owners resource is a child resource of the academic period sequence resource and identifies the institution and academic level for the academic period sequence.
• SequenceCode: string
  Maximum Length: 50

  The code of an academic period sequence.
• SequenceName: string
  Maximum Length: 50

  The name of an academic period sequence.
• StatusCode: string
  Title: Status Code

  Maximum Length: 30

  The code for an academic period sequence status. A list of accepted values is defined in the lookup type ORA_HER_SYSTEM_STATUS_CODE.
• StatusMeaning: string
  Maximum Length: 80

  The status for an academic period sequence, such as active or inactive. A list of accepted values is defined in the lookup type ORA_HER_SYSTEM_STATUS_CODE.

{
    "type":"object",
    "properties":{
        "SequenceName":{
            "maxLength":"50",
            "type":"string",
            "description":"The name of an academic period sequence.",
            "nullable":false
        },
        "StatusMeaning":{
            "maxLength":"80",
            "type":"string",
            "description":"The status for an academic period sequence, such as active or inactive. A list of accepted values is defined in the lookup type ORA_HER_SYSTEM_STATUS_CODE.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PeriodSequenceHeaderId":{
            "title":"Sequence Header ID",
            "type":"integer",
            "description":"The unique identifier for an academic period sequence.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"The description of an academic period sequence.",
            "nullable":true
        },
        "periodSequenceOwners":{
            "title":"Academic Period Sequence Owners",
            "type":"array",
            "description":"The academic period sequence owners resource is a child resource of the academic period sequence resource and identifies the institution and academic level for the academic period sequence.",
            "items":{
                "$ref":"#/components/schemas/academicPeriodSequences-periodSequenceOwners-item-patch-request"
            }
        },
        "levelOnePeriods":{
            "title":"Level One Academic Periods",
            "type":"array",
            "description":"The level one academic periods resource is a child resource of the academic period sequence resource and provides an ordered sequence of academic periods in the first level of the hierarchy.",
            "items":{
                "$ref":"#/components/schemas/academicPeriodSequences-levelOnePeriods-item-patch-request"
            }
        },
        "SequenceCode":{
            "maxLength":"50",
            "type":"string",
            "description":"The code of an academic period sequence.",
            "nullable":true
        },
        "StatusCode":{
            "title":"Status Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code for an academic period sequence status. A list of accepted values is defined in the lookup type ORA_HER_SYSTEM_STATUS_CODE.",
            "nullable":false
        }
    }
}

Nested Schema : Level One Academic Periods

Type: array

Title: Level One Academic Periods

The level one academic periods resource is a child resource of the academic period sequence resource and provides an ordered sequence of academic periods in the first level of the hierarchy.

Show Source

• Array of: object schema

{
    "title":"Level One Academic Periods",
    "type":"array",
    "description":"The level one academic periods resource is a child resource of the academic period sequence resource and provides an ordered sequence of academic periods in the first level of the hierarchy.",
    "items":{
        "$ref":"#/components/schemas/academicPeriodSequences-levelOnePeriods-item-patch-request"
    }
}

Nested Schema : Academic Period Sequence Owners

Type: array

Title: Academic Period Sequence Owners

The academic period sequence owners resource is a child resource of the academic period sequence resource and identifies the institution and academic level for the academic period sequence.

Show Source

• Array of: object schema

{
    "title":"Academic Period Sequence Owners",
    "type":"array",
    "description":"The academic period sequence owners resource is a child resource of the academic period sequence resource and identifies the institution and academic level for the academic period sequence.",
    "items":{
        "$ref":"#/components/schemas/academicPeriodSequences-periodSequenceOwners-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• AcademicPeriodId(required): integer (int64)
  Title: Academic Period ID

  The unique identifier for an academic period associated with a level one period.
• AcademicPeriodName: string
  Title: Academic Period Name

  Maximum Length: 50

  The academic period for a level one period.
• levelTwoPeriods: array Level Two Academic Periods
  Title: Level Two Academic Periods

  The level two academic periods resource is a child resource of the academic period sequence resource and provides an ordered sequence of academic periods in the second level of the hierarchy.
• OptionalFlag: boolean
  Title: Optional

  Maximum Length: 1

  Default Value: false

  Indicates whether a level one period is the optional level one period. The default value is false.
• ParentAcademicPeriodId: integer (int64)
  Title: Parent Academic Period ID

  The unique identifier for a parent academic period associated with a level one period.
• ParentAcademicPeriodName: string
  Title: Parent Academic Period Name

  Maximum Length: 50

  The parent academic period for a level one period.
• PeriodSequenceDetailId: integer (int64)
  Title: Sequence Detail ID

  The unique identifier for a level one period.
• SequenceNumber(required): integer (int32)
  Title: Sequence Number

  The number that identifies the sequence of a level one period.

{
    "required":[
        "AcademicPeriodId",
        "SequenceNumber"
    ],
    "type":"object",
    "properties":{
        "AcademicPeriodName":{
            "title":"Academic Period Name",
            "maxLength":"50",
            "type":"string",
            "description":"The academic period for a level one period.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SequenceNumber":{
            "title":"Sequence Number",
            "type":"integer",
            "description":"The number that identifies the sequence of a level one period.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "PeriodSequenceDetailId":{
            "title":"Sequence Detail ID",
            "type":"integer",
            "description":"The unique identifier for a level one period.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "AcademicPeriodId":{
            "title":"Academic Period ID",
            "type":"integer",
            "description":"The unique identifier for an academic period associated with a level one period.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ParentAcademicPeriodName":{
            "title":"Parent Academic Period Name",
            "maxLength":"50",
            "type":"string",
            "description":"The parent academic period for a level one period.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ParentAcademicPeriodId":{
            "title":"Parent Academic Period ID",
            "type":"integer",
            "description":"The unique identifier for a parent academic period associated with a level one period.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "levelTwoPeriods":{
            "title":"Level Two Academic Periods",
            "type":"array",
            "description":"The level two academic periods resource is a child resource of the academic period sequence resource and provides an ordered sequence of academic periods in the second level of the hierarchy.",
            "items":{
                "$ref":"#/components/schemas/academicPeriodSequences-levelOnePeriods-levelTwoPeriods-item-patch-request"
            }
        },
        "OptionalFlag":{
            "title":"Optional",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a level one period is the optional level one period. The default value is false.",
            "nullable":false,
            "default":false
        }
    }
}

Nested Schema : Level Two Academic Periods

Type: array

Title: Level Two Academic Periods

The level two academic periods resource is a child resource of the academic period sequence resource and provides an ordered sequence of academic periods in the second level of the hierarchy.

Show Source

• Array of: object academicPeriodSequences-levelOnePeriods-levelTwoPeriods-item-patch-request

{
    "title":"Level Two Academic Periods",
    "type":"array",
    "description":"The level two academic periods resource is a child resource of the academic period sequence resource and provides an ordered sequence of academic periods in the second level of the hierarchy.",
    "items":{
        "$ref":"#/components/schemas/academicPeriodSequences-levelOnePeriods-levelTwoPeriods-item-patch-request"
    }
}

Nested Schema : academicPeriodSequences-levelOnePeriods-levelTwoPeriods-item-patch-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : schema

Type: object

Show Source

• AcademicLevelId: integer (int64)
  Title: Academic Level ID

  The unique identifier for an academic level associated with a period sequence owner.
• AcademicLevelName: string
  Title: Academic Level Name

  Maximum Length: 100

  The academic level for a period sequence owner.
• InstitutionId: integer (int64)
  Title: Institution ID

  The unique identifier for an institution associated with a period sequence owner.
• InstitutionName: string
  Title: Institution

  Maximum Length: 50

  The institution for a period sequence owner.
• PeriodSequenceOwnerId: integer (int64)
  Title: Period Sequence Owner ID

  The unique identifier for a period sequence owner.

{
    "type":"object",
    "properties":{
        "AcademicLevelName":{
            "title":"Academic Level Name",
            "maxLength":"100",
            "type":"string",
            "description":"The academic level for a period sequence owner.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "InstitutionName":{
            "title":"Institution",
            "maxLength":"50",
            "type":"string",
            "description":"The institution for a period sequence owner.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AcademicLevelId":{
            "title":"Academic Level ID",
            "type":"integer",
            "description":"The unique identifier for an academic level associated with a period sequence owner.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "PeriodSequenceOwnerId":{
            "title":"Period Sequence Owner ID",
            "type":"integer",
            "description":"The unique identifier for a period sequence owner.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "InstitutionId":{
            "title":"Institution ID",
            "type":"integer",
            "description":"The unique identifier for an institution associated with a period sequence owner.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

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 : academicPeriodSequences-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created an academic period sequence.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when an academic period sequence was created.
• Description: string
  Title: Description

  Maximum Length: 240

  The description of an academic period sequence.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when an academic period sequence was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated an academic period sequence.
• levelOnePeriods: array Level One Academic Periods
  Title: Level One Academic Periods

  The level one academic periods resource is a child resource of the academic period sequence resource and provides an ordered sequence of academic periods in the first level of the hierarchy.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PeriodSequenceHeaderId: integer (int64)
  Title: Sequence Header ID

  The unique identifier for an academic period sequence.
• periodSequenceOwners: array Academic Period Sequence Owners
  Title: Academic Period Sequence Owners

  The academic period sequence owners resource is a child resource of the academic period sequence resource and identifies the institution and academic level for the academic period sequence.
• SequenceCode: string
  Maximum Length: 50

  The code of an academic period sequence.
• SequenceName: string
  Maximum Length: 50

  The name of an academic period sequence.
• StatusCode: string
  Title: Status Code

  Maximum Length: 30

  The code for an academic period sequence status. A list of accepted values is defined in the lookup type ORA_HER_SYSTEM_STATUS_CODE.
• StatusMeaning: string
  Maximum Length: 80

  The status for an academic period sequence, such as active or inactive. A list of accepted values is defined in the lookup type ORA_HER_SYSTEM_STATUS_CODE.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated an academic period sequence.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SequenceName":{
            "maxLength":"50",
            "type":"string",
            "description":"The name of an academic period sequence.",
            "nullable":false,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when an academic period sequence was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created an academic period sequence.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"The description of an academic period sequence.",
            "nullable":true,
            "x-queryable":true
        },
        "periodSequenceOwners":{
            "title":"Academic Period Sequence Owners",
            "type":"array",
            "description":"The academic period sequence owners resource is a child resource of the academic period sequence resource and identifies the institution and academic level for the academic period sequence.",
            "items":{
                "$ref":"#/components/schemas/academicPeriodSequences-periodSequenceOwners-item-response"
            }
        },
        "levelOnePeriods":{
            "title":"Level One Academic Periods",
            "type":"array",
            "description":"The level one academic periods resource is a child resource of the academic period sequence resource and provides an ordered sequence of academic periods in the first level of the hierarchy.",
            "items":{
                "$ref":"#/components/schemas/academicPeriodSequences-levelOnePeriods-item-response"
            }
        },
        "SequenceCode":{
            "maxLength":"50",
            "type":"string",
            "description":"The code of an academic period sequence.",
            "nullable":true,
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Status Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code for an academic period sequence status. A list of accepted values is defined in the lookup type ORA_HER_SYSTEM_STATUS_CODE.",
            "nullable":false,
            "x-queryable":true
        },
        "StatusMeaning":{
            "maxLength":"80",
            "type":"string",
            "description":"The status for an academic period sequence, such as active or inactive. A list of accepted values is defined in the lookup type ORA_HER_SYSTEM_STATUS_CODE.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PeriodSequenceHeaderId":{
            "title":"Sequence Header ID",
            "type":"integer",
            "description":"The unique identifier for an academic period sequence.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when an academic period sequence was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Level One Academic Periods

Type: array

Title: Level One Academic Periods

The level one academic periods resource is a child resource of the academic period sequence resource and provides an ordered sequence of academic periods in the first level of the hierarchy.

Show Source

• Array of: object academicPeriodSequences-levelOnePeriods-item-response

{
    "title":"Level One Academic Periods",
    "type":"array",
    "description":"The level one academic periods resource is a child resource of the academic period sequence resource and provides an ordered sequence of academic periods in the first level of the hierarchy.",
    "items":{
        "$ref":"#/components/schemas/academicPeriodSequences-levelOnePeriods-item-response"
    }
}

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 : Academic Period Sequence Owners

Type: array

Title: Academic Period Sequence Owners

The academic period sequence owners resource is a child resource of the academic period sequence resource and identifies the institution and academic level for the academic period sequence.

Show Source

• Array of: object academicPeriodSequences-periodSequenceOwners-item-response

{
    "title":"Academic Period Sequence Owners",
    "type":"array",
    "description":"The academic period sequence owners resource is a child resource of the academic period sequence resource and identifies the institution and academic level for the academic period sequence.",
    "items":{
        "$ref":"#/components/schemas/academicPeriodSequences-periodSequenceOwners-item-response"
    }
}

Nested Schema : academicPeriodSequences-levelOnePeriods-item-response

Type: object

Show Source

• AcademicPeriodId: integer (int64)
  Title: Academic Period ID

  The unique identifier for an academic period associated with a level one period.
• AcademicPeriodName: string
  Title: Academic Period Name

  Maximum Length: 50

  The academic period for a level one period.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created a level one period.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when a level one period was created.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when a level one period was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated a level one period.
• LatestLastDateToEnroll: string (date-time)
  Title: Latest Last Date to Enroll

  Read Only: true

  The latest last date to enroll for a level one period.
• levelTwoPeriods: array Level Two Academic Periods
  Title: Level Two Academic Periods

  The level two academic periods resource is a child resource of the academic period sequence resource and provides an ordered sequence of academic periods in the second level of the hierarchy.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OptionalFlag: boolean
  Title: Optional

  Maximum Length: 1

  Default Value: false

  Indicates whether a level one period is the optional level one period. The default value is false.
• ParentAcademicPeriodId: integer (int64)
  Title: Parent Academic Period ID

  The unique identifier for a parent academic period associated with a level one period.
• ParentAcademicPeriodName: string
  Title: Parent Academic Period Name

  Maximum Length: 50

  The parent academic period for a level one period.
• PeriodCategoryCode: string
  Title: Category Code

  Read Only: true

  Maximum Length: 30

  The period category code for a level one period. A list of accepted values is defined in the lookup type ORA_HER_PERIOD_CATEGORY_CODE.
• PeriodCategoryMeaning: string
  Title: Category

  Read Only: true

  Maximum Length: 80

  The period category code for a level one period, such as Academic, Holiday, Academic reporting, and Academic self-paced. A list of accepted values is defined in the lookup type ORA_HER_PERIOD_CATEGORY_CODE.
• PeriodEndDate: string (date)
  Title: Period End Date

  Read Only: true

  The date when the level one period ends.
• PeriodSequenceDetailId: integer (int64)
  Title: Sequence Detail ID

  The unique identifier for a level one period.
• PeriodStartDate: string (date)
  Title: Period Start Date

  Read Only: true

  The date when the level one period starts.
• SequenceNumber: integer (int32)
  Title: Sequence Number

  The number that identifies the sequence of a level one period.
• WeeksOfInstruction: integer (int32)
  Title: Weeks of Instruction

  Read Only: true

  Default Value: 1

  The week of instruction of a level one period.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated a level one period.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when a level one period was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created a level one period.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LatestLastDateToEnroll":{
            "title":"Latest Last Date to Enroll",
            "type":"string",
            "description":"The latest last date to enroll for a level one period.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentAcademicPeriodName":{
            "title":"Parent Academic Period Name",
            "maxLength":"50",
            "type":"string",
            "description":"The parent academic period for a level one period.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "WeeksOfInstruction":{
            "title":"Weeks of Instruction",
            "type":"integer",
            "description":"The week of instruction of a level one period.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "default":"1",
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "PeriodEndDate":{
            "title":"Period End Date",
            "type":"string",
            "description":"The date when the level one period ends.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PeriodCategoryMeaning":{
            "title":"Category",
            "maxLength":"80",
            "type":"string",
            "description":"The period category code for a level one period, such as Academic, Holiday, Academic reporting, and Academic self-paced. A list of accepted values is defined in the lookup type ORA_HER_PERIOD_CATEGORY_CODE.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PeriodStartDate":{
            "title":"Period Start Date",
            "type":"string",
            "description":"The date when the level one period starts.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OptionalFlag":{
            "title":"Optional",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a level one period is the optional level one period. The default value is false.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "AcademicPeriodName":{
            "title":"Academic Period Name",
            "maxLength":"50",
            "type":"string",
            "description":"The academic period for a level one period.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SequenceNumber":{
            "title":"Sequence Number",
            "type":"integer",
            "description":"The number that identifies the sequence of a level one period.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "PeriodSequenceDetailId":{
            "title":"Sequence Detail ID",
            "type":"integer",
            "description":"The unique identifier for a level one period.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AcademicPeriodId":{
            "title":"Academic Period ID",
            "type":"integer",
            "description":"The unique identifier for an academic period associated with a level one period.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ParentAcademicPeriodId":{
            "title":"Parent Academic Period ID",
            "type":"integer",
            "description":"The unique identifier for a parent academic period associated with a level one period.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "levelTwoPeriods":{
            "title":"Level Two Academic Periods",
            "type":"array",
            "description":"The level two academic periods resource is a child resource of the academic period sequence resource and provides an ordered sequence of academic periods in the second level of the hierarchy.",
            "items":{
                "$ref":"#/components/schemas/academicPeriodSequences-levelOnePeriods-levelTwoPeriods-item-response"
            }
        },
        "PeriodCategoryCode":{
            "title":"Category Code",
            "maxLength":"30",
            "type":"string",
            "description":"The period category code for a level one period. A list of accepted values is defined in the lookup type ORA_HER_PERIOD_CATEGORY_CODE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when a level one period was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Level Two Academic Periods

Type: array

Title: Level Two Academic Periods

The level two academic periods resource is a child resource of the academic period sequence resource and provides an ordered sequence of academic periods in the second level of the hierarchy.

Show Source

• Array of: object academicPeriodSequences-levelOnePeriods-levelTwoPeriods-item-response

{
    "title":"Level Two Academic Periods",
    "type":"array",
    "description":"The level two academic periods resource is a child resource of the academic period sequence resource and provides an ordered sequence of academic periods in the second level of the hierarchy.",
    "items":{
        "$ref":"#/components/schemas/academicPeriodSequences-levelOnePeriods-levelTwoPeriods-item-response"
    }
}

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 : academicPeriodSequences-levelOnePeriods-levelTwoPeriods-item-response

Type: object

Show Source

• AcademicPeriodId: integer (int64)
  Title: Academic Period ID

  Read Only: true

  The unique identifier for an academic period associated with a level two period.
• AcademicPeriodName: string
  Title: Academic Period Name

  Read Only: true

  Maximum Length: 50

  The academic period for a level two period.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PeriodCategoryCode: string
  Title: Category Code

  Read Only: true

  Maximum Length: 30

  The period category code for a level two period. A list of accepted values is defined in the lookup type ORA_HER_PERIOD_CATEGORY_CODE.
• PeriodCategoryMeaning: string
  Title: Category

  Read Only: true

  Maximum Length: 80

  The period category code for a level two period, such as Academic, Holiday, Academic reporting, and Academic self-paced. A list of accepted values is defined in the lookup type ORA_HER_PERIOD_CATEGORY_CODE.
• PeriodEndDate: string (date)
  Title: Period End Date

  Read Only: true

  The date when the level two period ends.
• PeriodStartDate: string (date)
  Title: Period Start Date

  Read Only: true

  The date when the level two period starts.
• WeeksOfInstruction: integer (int32)
  Title: Weeks of Instruction

  Read Only: true

  Default Value: 1

  The week of instruction of a level two period.

{
    "type":"object",
    "properties":{
        "AcademicPeriodName":{
            "title":"Academic Period Name",
            "maxLength":"50",
            "type":"string",
            "description":"The academic period for a level two period.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AcademicPeriodId":{
            "title":"Academic Period ID",
            "type":"integer",
            "description":"The unique identifier for an academic period associated with a level two period.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PeriodEndDate":{
            "title":"Period End Date",
            "type":"string",
            "description":"The date when the level two period ends.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WeeksOfInstruction":{
            "title":"Weeks of Instruction",
            "type":"integer",
            "description":"The week of instruction of a level two period.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "default":"1",
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "PeriodStartDate":{
            "title":"Period Start Date",
            "type":"string",
            "description":"The date when the level two period starts.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PeriodCategoryMeaning":{
            "title":"Category",
            "maxLength":"80",
            "type":"string",
            "description":"The period category code for a level two period, such as Academic, Holiday, Academic reporting, and Academic self-paced. A list of accepted values is defined in the lookup type ORA_HER_PERIOD_CATEGORY_CODE.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PeriodCategoryCode":{
            "title":"Category Code",
            "maxLength":"30",
            "type":"string",
            "description":"The period category code for a level two period. A list of accepted values is defined in the lookup type ORA_HER_PERIOD_CATEGORY_CODE.",
            "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 : 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 : academicPeriodSequences-periodSequenceOwners-item-response

Type: object

Show Source

• AcademicLevelId: integer (int64)
  Title: Academic Level ID

  The unique identifier for an academic level associated with a period sequence owner.
• AcademicLevelName: string
  Title: Academic Level Name

  Maximum Length: 100

  The academic level for a period sequence owner.
• InstitutionId: integer (int64)
  Title: Institution ID

  The unique identifier for an institution associated with a period sequence owner.
• InstitutionName: string
  Title: Institution

  Maximum Length: 50

  The institution for a period sequence owner.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PeriodSequenceOwnerId: integer (int64)
  Title: Period Sequence Owner ID

  The unique identifier for a period sequence owner.

{
    "type":"object",
    "properties":{
        "AcademicLevelName":{
            "title":"Academic Level Name",
            "maxLength":"100",
            "type":"string",
            "description":"The academic level for a period sequence owner.",
            "nullable":false,
            "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"
            }
        },
        "InstitutionName":{
            "title":"Institution",
            "maxLength":"50",
            "type":"string",
            "description":"The institution for a period sequence owner.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AcademicLevelId":{
            "title":"Academic Level ID",
            "type":"integer",
            "description":"The unique identifier for an academic level associated with a period sequence owner.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PeriodSequenceOwnerId":{
            "title":"Period Sequence Owner ID",
            "type":"integer",
            "description":"The unique identifier for a period sequence owner.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "InstitutionId":{
            "title":"Institution ID",
            "type":"integer",
            "description":"The unique identifier for an institution associated with a period sequence owner.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "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

levelOnePeriods

Operation: /fscmRestApi/resources/11.13.18.05/academicPeriodSequences/{PeriodSequenceHeaderId}/child/levelOnePeriods

Parameters:

• PeriodSequenceHeaderId: $request.path.PeriodSequenceHeaderId

The level one academic periods resource is a child resource of the academic period sequence resource and provides an ordered sequence of academic periods in the first level of the hierarchy.

periodSequenceOwners

Operation: /fscmRestApi/resources/11.13.18.05/academicPeriodSequences/{PeriodSequenceHeaderId}/child/periodSequenceOwners

Parameters:

• PeriodSequenceHeaderId: $request.path.PeriodSequenceHeaderId

The academic period sequence owners resource is a child resource of the academic period sequence resource and identifies the institution and academic level for the academic period sequence.

statusCodeLOV

Operation: /fscmRestApi/resources/11.13.18.05/herLookups

Parameters:

• finder: LookupTypeFinder

The following properties are defined on the LOV link relation:

• Source Attribute: StatusMeaning; Target Attribute: DisplayedField
• Display Attribute: DisplayedField

Back to Top