Jump to

• Request
• Response

Get an academic organization

get

/fscmRestApi/resources/11.13.18.05/academicInstitutions/{InstitutionId}/child/academicOrganizations/{AcademicOrgId}

Request

Path Parameters

• AcademicOrgId(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=
• InstitutionId(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: 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.

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 : academicInstitutions-academicOrganizations-item-response

Type: object

Show Source

• AcademicOrgId: integer (int64)
  Title: Academic Organization ID

  Read Only: true

  The unique identifier for an academic organization.
• AcademicOrgName: string
  Title: Academic Organization

  Maximum Length: 100

  The name of the academic organization.
• AcademicOrgTypeCode: string
  Title: Academic Organization Type

  Maximum Length: 30

  Indicates the type of academic organization. A list of accepted values is defined in the lookup type ORA_HER_ACADEMIC_ORG_TYPE.
• AcademicOrgTypeMeaning: string
  Title: Academic Organization Type

  Read Only: true

  Maximum Length: 80

  The meaning of the academic organization type code. A list of accepted values is defined in the lookup type ORA_HER_ACADEMIC_ORG_TYPE.
• ActiveFlag: boolean
  Title: Active

  Maximum Length: 1

  Default Value: true

  Indicates whether the academic organization is active and available to use.
• BusinessUnitId: integer (int64)
  Title: Business Unit

  The business unit associated with the academic organization.
• CampusId: integer (int64)
  Title: Campus ID

  The unique identifier for the campus associated with the academic organization.
• CampusName: string
  Title: Campus

  Read Only: true

  The name of the campus associated with the academic organization.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the row.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date the row was created.
• Description: string
  Title: Description

  Maximum Length: 1000

  The description of the academic organization.
• EndDate: string (date)
  Title: End Date

  The end or expiration date of the academic organization.
• InstitutionId: integer (int64)
  Title: Institution ID

  The unique identifier for the academic institution associated with the academic organization.
• InstitutionName: string
  Title: Institution

  Read Only: true

  The name of the institution associated with the academic organization.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date the row was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the row.
• links: array Links
  Title: Links

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

  Maximum Length: 100

  The code identifier of an academic organization.
• organizationStorefronts: array Offering Storefronts
  Title: Offering Storefronts

  Storefronts organize curriculum items into groups that can be presented with different branding to different audiences.
• StartDate: string (date)
  Title: Start Date

  The start date of the academic organization.
• StatusCode: string
  Title: Status

  Maximum Length: 30

  Default Value: ORA_ACTIVE

  The status code of the academic organization. This controls the availability of the academic organization for associations with other academic entities.
• StatusMeaning: string
  Title: Status

  Read Only: true

  Maximum Length: 80

  The status of the academic organization.
• StorefrontOptionCode: string
  Title: Storefront

  Maximum Length: 30

  The storefront option code of the academic organization.

{
    "type":"object",
    "properties":{
        "AcademicOrgId":{
            "title":"Academic Organization ID",
            "type":"integer",
            "description":"The unique identifier for an academic organization.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "AcademicOrgName":{
            "title":"Academic Organization",
            "maxLength":100,
            "type":"string",
            "description":"The name of the academic organization.",
            "nullable":false,
            "x-queryable":true
        },
        "AcademicOrgTypeCode":{
            "title":"Academic Organization Type",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the type of academic organization. A list of accepted values is defined in the lookup type ORA_HER_ACADEMIC_ORG_TYPE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AcademicOrgTypeMeaning":{
            "title":"Academic Organization Type",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the academic organization type code. A list of accepted values is defined in the lookup type ORA_HER_ACADEMIC_ORG_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the academic organization is active and available to use.",
            "nullable":true,
            "default":true,
            "x-queryable":true
        },
        "BusinessUnitId":{
            "title":"Business Unit",
            "type":"integer",
            "description":"The business unit associated with the academic organization.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CampusId":{
            "title":"Campus ID",
            "type":"integer",
            "description":"The unique identifier for the campus associated with the academic organization.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "CampusName":{
            "title":"Campus",
            "type":"string",
            "description":"The name of the campus associated with the academic organization.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show",
                "dependencies":[
                    "CampusId"
                ]
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"The description of the academic organization.",
            "nullable":true,
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The end or expiration date of the academic organization.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "InstitutionId":{
            "title":"Institution ID",
            "type":"integer",
            "description":"The unique identifier for the academic institution associated with the academic organization.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "InstitutionName":{
            "title":"Institution",
            "type":"string",
            "description":"The name of the institution associated with the academic organization.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show",
                "dependencies":[
                    "InstitutionId"
                ]
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationCode":{
            "title":"Code",
            "maxLength":100,
            "type":"string",
            "description":"The code identifier of an academic organization.",
            "nullable":true,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The start date of the academic organization.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The status code of the academic organization. This controls the availability of the academic organization for associations with other academic entities.",
            "nullable":false,
            "default":"ORA_ACTIVE",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StatusMeaning":{
            "title":"Status",
            "maxLength":80,
            "type":"string",
            "description":"The status of the academic organization.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StorefrontOptionCode":{
            "title":"Storefront",
            "maxLength":30,
            "type":"string",
            "description":"The storefront option code of the academic organization.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "organizationStorefronts":{
            "title":"Offering Storefronts",
            "type":"array",
            "description":"Storefronts organize curriculum items into groups that can be presented with different branding to different audiences.",
            "items":{
                "$ref":"#/components/schemas/academicInstitutions-academicOrganizations-organizationStorefronts-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 : Offering Storefronts

Type: array

Title: Offering Storefronts

Storefronts organize curriculum items into groups that can be presented with different branding to different audiences.

Show Source

• Array of: object academicInstitutions-academicOrganizations-organizationStorefronts-item-response

{
    "title":"Offering Storefronts",
    "type":"array",
    "description":"Storefronts organize curriculum items into groups that can be presented with different branding to different audiences.",
    "items":{
        "$ref":"#/components/schemas/academicInstitutions-academicOrganizations-organizationStorefronts-item-response"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

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

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

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

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

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

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

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

Nested Schema : properties

Type: object

Show Source

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

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

Nested Schema : academicInstitutions-academicOrganizations-organizationStorefronts-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• StorefrontId: integer (int64)
  Title: Storefront ID

  Read Only: true

  The unique identifier for the offering storefront.
• StorefrontName: string
  Title: Storefront Name

  Read Only: true

  The name of the offering storefront.

{
    "type":"object",
    "properties":{
        "StorefrontId":{
            "title":"Storefront ID",
            "type":"integer",
            "description":"The unique identifier for the offering storefront.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "StorefrontName":{
            "title":"Storefront Name",
            "type":"string",
            "description":"The name of the offering storefront.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show",
                "dependencies":[
                    "StorefrontId"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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

AcademicOrgTypeCodeLOV

Operation: /fscmRestApi/resources/11.13.18.05/herLookups

Parameters:

• finder: ByLookupTypeFinder%3BLookupCode%3D{AcademicOrgTypeCode}%2CLookupType%3DORA_HER_ACADEMIC_ORG_TYPE

The following properties are defined on the LOV link relation:

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

CampusLOV

Operation: /fscmRestApi/resources/11.13.18.05/campuses

The following properties are defined on the LOV link relation:

• Source Attribute: CampusId; Target Attribute: CampusId
• Display Attribute: CampusName

InstitutionLOV

Operation: /fscmRestApi/resources/11.13.18.05/academicInstitutions

The following properties are defined on the LOV link relation:

• Source Attribute: InstitutionId; Target Attribute: InstitutionId
• Display Attribute: InstitutionName

StatusLOV

Operation: /fscmRestApi/resources/11.13.18.05/herLookups

Parameters:

• finder: ByLookupTypeFinder%3BLookupCode%3D{StatusCode}%2CLookupType%3DORA_HER_ACADEMIC_ORG_STATUS

The following properties are defined on the LOV link relation:

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

organizationStorefronts

Operation: /fscmRestApi/resources/11.13.18.05/academicInstitutions/{InstitutionId}/child/academicOrganizations/{AcademicOrgId}/child/organizationStorefronts

Parameters:

• AcademicOrgId: $request.path.AcademicOrgId
• InstitutionId: $request.path.InstitutionId

Storefronts organize curriculum items into groups that can be presented with different branding to different audiences.

Back to Top