Jump to

• Request
• Response

Update a managed student group member approval

patch

/fscmRestApi/resources/11.13.18.05/hedProxyGroupMemberApprovals/{ApprovalId}

Request

Path Parameters

• ApprovalId(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=

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/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ApprovalStatusCode: string
  Title: Approval Status

  Maximum Length: 30

  Unique identifier of the approval status.

{
    "type":"object",
    "properties":{
        "ApprovalStatusCode":{
            "title":"Approval Status",
            "maxLength":"30",
            "type":"string",
            "description":"Unique identifier of the approval status.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

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 : hedProxyGroupMemberApprovals-item-response

Type: object

Show Source

• ApprovalId: integer (int64)
  Title: Approval ID

  Read Only: true

  Unique identifier of the approval.
• ApprovalStatusCode: string
  Title: Approval Status

  Maximum Length: 30

  Unique identifier of the approval status.
• ApproveeFirstName: string
  Title: Member First Name

  Read Only: true

  Maximum Length: 150

  The first name of the managed student group member.
• ApproveeLastName: string
  Title: Member Last Name

  Read Only: true

  Maximum Length: 150

  The last name of the managed student group member.
• ApproveePreferredName: string
  Title: Member Preferred Name

  Read Only: true

  Maximum Length: 360

  The preferred name of the managed student group member.
• ConsumerResourceId: integer (int64)
  Title: Consumer Resource ID

  Read Only: true

  Unique identifier of the consumer resource.
• EventDate: string (date)
  Title: Approval Status Date

  Read Only: true

  Date when the record was created.
• GroupName: string
  Title: Proxy Group Name

  Read Only: true

  Maximum Length: 100

  The managed student group to which the member belongs.
• GroupOwnerName: string
  Title: Group Owner Name

  Read Only: true

  Maximum Length: 360

  The name of the group owner.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RecipientId: integer (int64)
  Title: Proxy Member ID

  Read Only: true

  Unique identifier of the managed student group member.
• RelationshipWithGroupOwner: string
  Title: Relationship with Group Owner

  Read Only: true

  Maximum Length: 255

  The relationship of the student with the group owner.
• RequestorEmailAddress: string
  Title: Requester Email

  Read Only: true

  Maximum Length: 320

  The email address of the group manager who's sending the invitation to join the group.
• RequestorPreferredName: string
  Title: Requester Name

  Read Only: true

  Maximum Length: 360

  The preferred name of the group manager who's sending the invitation to join the group.

{
    "type":"object",
    "properties":{
        "GroupName":{
            "title":"Proxy Group Name",
            "maxLength":"100",
            "type":"string",
            "description":"The managed student group to which the member belongs.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RequestorEmailAddress":{
            "title":"Requester Email",
            "maxLength":"320",
            "type":"string",
            "description":"The email address of the group manager who's sending the invitation to join the group.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "EventDate":{
            "title":"Approval Status Date",
            "type":"string",
            "description":"Date when the record was created.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RecipientId":{
            "title":"Proxy Member ID",
            "type":"integer",
            "description":"Unique identifier of the managed student group member.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ApproveePreferredName":{
            "title":"Member Preferred Name",
            "maxLength":"360",
            "type":"string",
            "description":"The preferred name of the managed student group member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApprovalId":{
            "title":"Approval ID",
            "type":"integer",
            "description":"Unique identifier of the approval.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "RelationshipWithGroupOwner":{
            "title":"Relationship with Group Owner",
            "maxLength":"255",
            "type":"string",
            "description":"The relationship of the student with the group owner.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequestorPreferredName":{
            "title":"Requester Name",
            "maxLength":"360",
            "type":"string",
            "description":"The preferred name of the group manager who's sending the invitation to join the group.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApprovalStatusCode":{
            "title":"Approval Status",
            "maxLength":"30",
            "type":"string",
            "description":"Unique identifier of the approval status.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ApproveeFirstName":{
            "title":"Member First Name",
            "maxLength":"150",
            "type":"string",
            "description":"The first name of the managed student group member.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonFirstName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"First Name"
            },
            "x-queryable":true
        },
        "ApproveeLastName":{
            "title":"Member Last Name",
            "maxLength":"150",
            "type":"string",
            "description":"The last name of the managed student group member.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonLastName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Last Name"
            },
            "x-queryable":true
        },
        "GroupOwnerName":{
            "title":"Group Owner Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the group owner.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ConsumerResourceId":{
            "title":"Consumer Resource ID",
            "type":"integer",
            "description":"Unique identifier of the consumer resource.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"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

HeyLookupVO1

Operation: /fscmRestApi/resources/11.13.18.05/heyLookups

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_HEY_PROXY_MBR_APV_STATUS

The following properties are defined on the LOV link relation:

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

Back to Top