Jump to

• Request
• Response

Get all level one periods

get

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

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=

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables
  
  

  • PrimaryKey Finds all level one period instances that match the primary key criteria specified.
    Finder Variables
    • PeriodSequenceDetailId; integer; Unique identifier for a level one period instance.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • AcademicPeriodId; integer; The unique identifier for an academic period associated with a level one period.
  • AcademicPeriodName; string; The academic period for a level one period.
  • CreatedBy; string; The user who created a level one period.
  • CreationDate; string; The date when a level one period was created.
  • LastUpdateDate; string; The date when a level one period was last updated.
  • LastUpdatedBy; string; The user who last updated a level one period.
  • LatestLastDateToEnroll; string; The latest last date to enroll for a level one period.
  • OptionalFlag; boolean; Indicates whether a level one period is the optional level one period. The default value is false.
  • ParentAcademicPeriodId; integer; The unique identifier for a parent academic period associated with a level one period.
  • ParentAcademicPeriodName; string; The parent academic period for a level one period.
  • PeriodCategoryCode; string; 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; 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; The date when the level one period ends.
  • PeriodSequenceDetailId; integer; The unique identifier for a level one period.
  • PeriodStartDate; string; The date when the level one period starts.
  • SequenceNumber; integer; The number that identifies the sequence of a level one period.
  • WeeksOfInstruction; integer; The week of instruction of a level one period.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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.

There's no request body for this operation.

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-levelOnePeriods

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/academicPeriodSequences-levelOnePeriods-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

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

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "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 : 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."
        }
    }
}

Back to Top