Get an academic plan format
get
/fscmRestApi/resources/11.13.18.05/academicPlanFormats/{PlanFormatId}
Request
Path Parameters
-
PlanFormatId(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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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 TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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.
Root Schema : academicPlanFormats-item-response
Type:
Show Source
object
-
ActiveFlag: boolean
Title:
Active
Maximum Length:1
Default Value:true
Indicates whether the plan format is active. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
Who column: indicates the user who created the row. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Who column: indicates the date and time of the creation of the row. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Who column: indicates the date and time of the last update of the row. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
Who column: indicates the user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
periods: array
Periods
Title:
Periods
The periods resource is a child of the academic plan formats resource and provides a complete list of academic periods associated with an academic plan format. -
PlanFormatCode: string
Title:
Format Code
Maximum Length:30
Code of the plan format. -
PlanFormatDescription: string
(byte)
Title:
Format Description
Description of the plan format. -
PlanFormatId: integer
(int64)
Title:
Plan Format ID
Unique identifier for the plan format. -
PlanFormatName: string
Title:
Format Name
Maximum Length:50
Name of the plan format.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Periods
Type:
array
Title:
Periods
The periods resource is a child of the academic plan formats resource and provides a complete list of academic periods associated with an academic plan format.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : academicPlanFormats-periods-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
Who column: indicates the user who created the row. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Who column: indicates the date and time of the creation of the row. -
EnrollablePeriodFlag: boolean
Maximum Length:
1
Default Value:false
The period is one in which courses are offered for enrollment. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Who column: indicates the date and time of the last update of the row. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
Who column: indicates the user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ParentPeriodId: integer
(int64)
Title:
Parent Period ID
Identifier for the plan format parent period. -
PeriodCode: string
Title:
Period Code
Maximum Length:30
Code of the plan format period. -
PeriodId: integer
(int64)
Title:
Period ID
Unique identifier for the plan format period. -
PeriodLevelNumber: integer
(int32)
Title:
Period Level Number
Level of the plan format period. -
PeriodName: string
Title:
Period Name
Maximum Length:50
Name of the plan format period. -
PeriodSequenceNumber: integer
(int32)
Title:
Period Sequence Number
Sequence of the plan format period within a level. -
tags: array
Tags
Title:
Tags
The tags resource is a child resource of the periods resource and contains the valid period tags for a format period. -
tiers: array
Tiers
Title:
Tiers
The tiers resource is a child resource of the periods resource and contains the valid period tiers for a format period.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Tiers
Type:
array
Title:
Tiers
The tiers resource is a child resource of the periods resource and contains the valid period tiers for a format period.
Show Source
Nested Schema : academicPlanFormats-periods-tiers-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
Who column: indicates the user who created the row. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Who column: indicates the date and time of the creation of the row. -
FormatPeriodTierId: integer
(int64)
The plan format period tier unique identifier.
-
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Who column: indicates the date and time of the last update of the row. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
Who column: indicates the user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PeriodTierCode: string
Maximum Length:
30
The academic period tier that's valid for this plan period.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- periods
-
Parameters:
- PlanFormatId:
$request.path.PlanFormatId
The periods resource is a child of the academic plan formats resource and provides a complete list of academic periods associated with an academic plan format. - PlanFormatId: