Jump to

• Request
• Response

Retrieve inherited settings

post

/fscmRestApi/resources/11.13.18.05/academicEntities/action/getInheritedSettings

Retrieves all possible settings of the passed setting type inherited by the passed academic entity ID and entity type. The settings returned should always have an assignment method of Direct.

Request

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/vnd.oracle.adf.action+json

Request Body - application/vnd.oracle.adf.action+json ()

Root Schema : schema

Type: object

Show Source

• entityId: number
  The entity ID for which inherited settings should be retrieved.
• entityTypeCode: string
  The entity type code for which inherited settings should be retrieved. For example ORA_HER_ACADEMIC_ORG.
• settingsTypeCode: string
  The settings type assigned to the entity for which inherited settings should be retrieved. For example ORA_HER_WAITLIST.

{
    "type":"object",
    "properties":{
        "entityTypeCode":{
            "type":"string",
            "description":"The entity type code for which inherited settings should be retrieved. For example ORA_HER_ACADEMIC_ORG.",
            "nullable":true
        },
        "entityId":{
            "type":"number",
            "description":"The entity ID for which inherited settings should be retrieved.",
            "nullable":true
        },
        "settingsTypeCode":{
            "type":"string",
            "description":"The settings type assigned to the entity for which inherited settings should be retrieved. For example ORA_HER_WAITLIST.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.oracle.adf.actionresult+json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : schema

Type: object

Show Source

• result(required): string
  The return value of this custom method. It returns a JSON array of all inherited settings for the passed entity.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"string",
            "description":"The return value of this custom method. It returns a JSON array of all inherited settings for the passed entity."
        }
    },
    "additionalProperties":false
}

Back to Top