Jump to

• Request
• Response

Create a child academic period

post

/fscmRestApi/resources/11.13.18.05/hedAcademicPeriods/{AcademicPeriodId}/child/childPeriods

Request

Path Parameters

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

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

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

  The identifier of the child academic period.

{
    "type":"object",
    "properties":{
        "AcademicPeriodId":{
            "title":"Academic Period ID",
            "type":"integer",
            "description":"The identifier of the child academic period.",
            "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 : hedAcademicPeriods-childPeriods-item-response

Type: object

Show Source

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

  The identifier of the child academic period.
• Description: string
  Title: Description

  Read Only: true

  Maximum Length: 1000

  The description of an academic period.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PeriodAssociationId: integer (int64)
  Title: Academic Period Association ID

  Read Only: true

  The unique identifier of an academic period association.
• PeriodCategoryCode: string
  Title: Category Code

  Read Only: true

  Maximum Length: 30

  The category code of an academic period.
• PeriodCategoryMeaning: string
  Title: Category Meaning

  Read Only: true

  Maximum Length: 80

  The category meaning of an academic period.
• PeriodCode: string
  Title: Period Code

  Read Only: true

  Maximum Length: 50

  The code of an academic period.
• PeriodEndDate: string (date-time)
  Title: End Date

  Read Only: true

  The date when an academic period ends.
• PeriodName: string
  Title: Name

  Read Only: true

  Maximum Length: 50

  The name of an academic period.
• PeriodStartDate: string (date-time)
  Title: Start Date

  Read Only: true

  The date when an academic period starts.
• WeeksOfInstruction: integer (int32)
  Title: Weeks of Instruction

  Read Only: true

  Default Value: 1

  The weeks of instructions of an academic period.

{
    "type":"object",
    "properties":{
        "Description":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"The description of an academic period.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PeriodAssociationId":{
            "title":"Academic Period Association ID",
            "type":"integer",
            "description":"The unique identifier of an academic period association.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "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"
            }
        },
        "PeriodName":{
            "title":"Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of an academic period.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PeriodCode":{
            "title":"Period Code",
            "maxLength":50,
            "type":"string",
            "description":"The code of an academic period.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AcademicPeriodId":{
            "title":"Academic Period ID",
            "type":"integer",
            "description":"The identifier of the child academic period.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "WeeksOfInstruction":{
            "title":"Weeks of Instruction",
            "type":"integer",
            "description":"The weeks of instructions of an academic period.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "default":1,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "PeriodEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when an academic period ends.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PeriodCategoryMeaning":{
            "title":"Category Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The category meaning of an academic period.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PeriodStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when an academic period starts.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PeriodCategoryCode":{
            "title":"Category Code",
            "maxLength":30,
            "type":"string",
            "description":"The category code of an academic period.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

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

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

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

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

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

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

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

Nested Schema : properties

Type: object

Show Source

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

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

Links

periodCategoryLOV

Operation: /fscmRestApi/resources/11.13.18.05/herLookups

Parameters:

• finder: ByLookupTypeFinder%3BLookupType%3DORA_HER_PERIOD_CATEGORY_CODE%2CLookupCode%3D{PeriodCategoryCode}

List of values for period categories

Back to Top