REST API for Oracle Fusion Cloud HCM

Get a change request

get

/hcmRestApi/resources/11.13.18.05/learningSelfPacedItems/{learningSelfPacedItemsUniqID}/child/changeRequests/{changeRequestId}

Request

Path Parameters

changeRequestId(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=
learningSelfPacedItemsUniqID(required): string

This is the hash key of the attributes which make up the composite key for the Learning Self-Paced Items resource and used to uniquely identify an instance of Learning Self-Paced Items. The client should not generate the hash key value. Instead, the client should query on the Learning Self-Paced Items collection resource in order to navigate to a specific instance of Learning Self-Paced Items to get the hash key.

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.

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.

Root Schema : learningSelfPacedItems-changeRequests-item-response

Type: object

Show Source

changeRequestId: integer (int64)

Unique identifier for the change request.
comment: string

Maximum Length: 4000

Optional comment that explains the need for this change.
createdByDisplayName: string

Read Only: true

Display name of the change requester.
createdById: integer (int64)

Identifier for the change requester.
creationDate: string (date-time)

Read Only: true

Date when the change request was created.
deleteExistingContent: string

Maximum Length: 30

Indicates whether the change request should delete existing content. Possible values are Yes, No, or Not Applicable.
links: array Links

Title: Links

The link relations associated with the resource instance.
notificationMessage: string

Maximum Length: 4000

Notification message text sent to the learners.
notifyLearners: string

Maximum Length: 30

Indicates whether to notify learners about this change request. Possible values are Yes, No, or Not Applicable.
processingStatus: string

Maximum Length: 30

Processing status for the change request.
processingStatusMeaning: string

Read Only: true

Maximum Length: 255

Description for the change request processing status.
reasonCode: string

Maximum Length: 30

Reason for reconciliation.
reasonCodeMeaning: string

Read Only: true

Maximum Length: 255

Description for the reasonCode attribute value.
reconcileByDisplayName: string

Read Only: true

Maximum Length: 255

Display name of the person reconciling the change request.
reconcileById: integer (int64)

Identifier for the person reconciling the change request.
reconcileEndDate: string (date-time)

Date and time when the change request reconciliation should end.
reconcileLastRunProcessDate: string (date-time)

Date and time when the change request was most recently reconciled.
reconcileLastRunProcessId: integer (int64)

Unique identifier associated with the most recent reconciliation run for the change request.
reconcileStartDate: string (date-time)

Date and time to start the change request reconciliation.
restartInProgressAttempts: string

Maximum Length: 30

Indicates whether in-progress attempts need to be restarted. Possible values are Yes, No, or Not Applicable.
status: string

Maximum Length: 30

Status for the change request.

{
    "type":"object",
    "properties":{
        "changeRequestId":{
            "type":"integer",
            "description":"Unique identifier for the change request.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "reconcileEndDate":{
            "type":"string",
            "description":"Date and time when the change request reconciliation should end.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "restartInProgressAttempts":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether in-progress attempts need to be restarted. Possible values are Yes, No, or Not Applicable.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "CATEGORY":"General"
            },
            "x-queryable":true
        },
        "deleteExistingContent":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether the change request should delete existing content. Possible values are Yes, No, or Not Applicable.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "CATEGORY":"General"
            },
            "x-queryable":true
        },
        "notificationMessage":{
            "maxLength":4000,
            "type":"string",
            "description":"Notification message text sent to the learners.",
            "nullable":true,
            "x-queryable":true
        },
        "reconcileLastRunProcessId":{
            "type":"integer",
            "description":"Unique identifier associated with the most recent reconciliation run for the change request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "creationDate":{
            "type":"string",
            "description":"Date when the change request was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "createdByDisplayName":{
            "type":"string",
            "description":"Display name of the change requester.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "reasonCodeMeaning":{
            "maxLength":255,
            "type":"string",
            "description":"Description for the reasonCode attribute value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "processingStatus":{
            "maxLength":30,
            "type":"string",
            "description":"Processing status for the change request.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "CATEGORY":"General"
            },
            "x-queryable":true
        },
        "processingStatusMeaning":{
            "maxLength":255,
            "type":"string",
            "description":"Description for the change request processing status.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "reconcileStartDate":{
            "type":"string",
            "description":"Date and time to start the change request reconciliation.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "notifyLearners":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether to notify learners about this change request. Possible values are Yes, No, or Not Applicable.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "CATEGORY":"General"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "comment":{
            "maxLength":4000,
            "type":"string",
            "description":"Optional comment that explains the need for this change.",
            "nullable":true,
            "x-queryable":true
        },
        "reasonCode":{
            "maxLength":30,
            "type":"string",
            "description":"Reason for reconciliation.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "CATEGORY":"General"
            },
            "x-queryable":true
        },
        "reconcileByDisplayName":{
            "maxLength":255,
            "type":"string",
            "description":"Display name of the person reconciling the change request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "reconcileById":{
            "type":"integer",
            "description":"Identifier for the person reconciling the change request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "createdById":{
            "type":"integer",
            "description":"Identifier for the change requester.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "reconcileLastRunProcessDate":{
            "type":"string",
            "description":"Date and time when the change request was most recently reconciled.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "status":{
            "maxLength":30,
            "type":"string",
            "description":"Status for the change request.",
            "nullable":true,
            "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

DeleteContentVA

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

finder: LookupTypeFinder%3BLookupType%3DORA_WLF_DELETE_CONTENT