Jump to

• Request
• Response

Activate existing profiles

post

/fscmRestApi/resources/11.13.18.05/personProfiles/action/activateProfiles

Activates existing profiles to make them compliant with the requirements of Student Management.

Request

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

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

Root Schema : schema

Type: object

Show Source

• PartyIds: array PartyIds
  The identifiers for person objects.
• RoleCodes: array RoleCodes
  The unique codes for security roles.
• RunDateTime: string (date-time)
  The date and time for this profile activation to run. If this value isn't provided, the job will be scheduled immediately.

{
    "type":"object",
    "properties":{
        "RunDateTime":{
            "type":"string",
            "description":"The date and time for this profile activation to run. If this value isn't provided, the job will be scheduled immediately.",
            "format":"date-time",
            "nullable":true
        },
        "RoleCodes":{
            "type":"array",
            "description":"The unique codes for security roles.",
            "nullable":true,
            "items":{
                "type":"string"
            }
        },
        "PartyIds":{
            "type":"array",
            "description":"The identifiers for person objects.",
            "nullable":true,
            "items":{
                "type":"number"
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : PartyIds

Type: array

The identifiers for person objects.

Show Source

• Array of: number

{
    "type":"array",
    "description":"The identifiers for person objects.",
    "nullable":true,
    "items":{
        "type":"number"
    }
}

Nested Schema : RoleCodes

Type: array

The unique codes for security roles.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The unique codes for security roles.",
    "nullable":true,
    "items":{
        "type":"string"
    }
}

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): object result
  Additional Properties Allowed: additionalProperties

  The unique identifier of the scheduled process that performs the profile activation. This value is provided in the RequestId attribute of the response.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"number"
            },
            "description":"The unique identifier of the scheduled process that performs the profile activation. This value is provided in the RequestId attribute of the response."
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: object

Additional Properties Allowed

Show Source

• number

{
    "type":"object",
    "additionalProperties":{
        "type":"number"
    },
    "description":"The unique identifier of the scheduled process that performs the profile activation. This value is provided in the RequestId attribute of the response."
}

The unique identifier of the scheduled process that performs the profile activation. This value is provided in the RequestId attribute of the response.

Back to Top