Jump to

• Request
• Response

Get a Student Management organization name

get

/fscmRestApi/resources/11.13.18.05/hedOrganizationContacts/{ContactPartyId}/child/names/{namesUniqID}

Request

Path Parameters

• ContactPartyId(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=
• namesUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Student Management Organization Contact Names resource and used to uniquely identify an instance of Student Management Organization Contact Names. The client should not generate the hash key value. Instead, the client should query on the Student Management Organization Contact Names collection resource in order to navigate to a specific instance of Student Management Organization Contact Names 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:
  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.

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 : hedOrganizationContacts-names-item-response

Type: object

Show Source

• FirstName: string
  Title: First Name

  Maximum Length: 150

  The first name of a person.
• FullName: string
  Title: Full Name

  Maximum Length: 360

  The first and last name of the person displayed as a single string.
• LastName: string
  Title: Last Name

  Maximum Length: 150

  The last name of a person.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MiddleName: string
  Title: Middle Name

  Maximum Length: 60

  The middle name of a person.
• NameSuffix: string
  Title: Name Suffix

  Maximum Length: 30

  The name suffix of a person such as junior or senior.
• NameTypeCode: string
  Title: Name Type

  Maximum Length: 30

  The type of the name. It's a value defined by the Additional Party Name and Identifier Type entity. A list of accepted values is defined in the lookup type ORA_HEY_NAME_TYPE.
• NameTypeMeaning: string
  Title: Name Type

  Read Only: true

  Maximum Length: 80

  The meaning of the name type code. A list of accepted values is defined in the lookup type ORA_HEY_NAME_TYPE.
• PartyNameId: integer (int64)
  Title: Party Name ID

  Read Only: true

  The unique identifier for a name.
• PreferredFlag: boolean
  Title: Preferred

  Indicates that this name record contains the person's preferred name.
• SingleNameFlag: boolean
  Title: Only One Name

  Maximum Length: 1

  Default Value: false

  Indicates if the person has single name, typically a last name only, and that other names such as first name and middle name are intentionally blank.
• Title: string
  Title: Title

  Maximum Length: 60

  The title of the person, such as Mr or Mrs.

{
    "type":"object",
    "properties":{
        "FirstName":{
            "title":"First Name",
            "maxLength":"150",
            "type":"string",
            "description":"The first name of a person.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonFirstName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"First Name",
                "dependencies":[
                    "SingleNameFlag"
                ]
            },
            "x-queryable":true
        },
        "NameTypeMeaning":{
            "title":"Name Type",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the name type code. A list of accepted values is defined in the lookup type ORA_HEY_NAME_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FullName":{
            "title":"Full Name",
            "maxLength":"360",
            "type":"string",
            "description":"The first and last name of the person displayed as a single string.",
            "nullable":true,
            "x-hints":{
                "HR_ATTRIBUTE":"Y"
            },
            "x-queryable":true
        },
        "Title":{
            "title":"Title",
            "maxLength":"60",
            "type":"string",
            "description":"The title of the person, such as Mr or Mrs.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "NameSuffix":{
            "title":"Name Suffix",
            "maxLength":"30",
            "type":"string",
            "description":"The name suffix of a person such as junior or senior.",
            "nullable":true,
            "x-queryable":true
        },
        "LastName":{
            "title":"Last Name",
            "maxLength":"150",
            "type":"string",
            "description":"The last name of a person.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonLastName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Last Name"
            },
            "x-queryable":true
        },
        "SingleNameFlag":{
            "title":"Only One Name",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the person has single name, typically a last name only, and that other names such as first name and middle name are intentionally blank.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "MiddleName":{
            "title":"Middle Name",
            "maxLength":"60",
            "type":"string",
            "description":"The middle name of a person.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonMiddleName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Middle Name",
                "dependencies":[
                    "SingleNameFlag"
                ]
            },
            "x-queryable":true
        },
        "NameTypeCode":{
            "title":"Name Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of the name. It's a value defined by the Additional Party Name and Identifier Type entity. A list of accepted values is defined in the lookup type ORA_HEY_NAME_TYPE.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PreferredFlag":{
            "title":"Preferred",
            "type":"boolean",
            "description":"Indicates that this name record contains the person's preferred name.",
            "nullable":true,
            "x-queryable":false
        },
        "PartyNameId":{
            "title":"Party Name ID",
            "type":"integer",
            "description":"The unique identifier for a name.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true",
                "HR_ATTRIBUTE":"Y"
            },
            "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

NameTypeLOV

Operation: /fscmRestApi/resources/11.13.18.05/heyLookups

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_HEY_NAME_TYPE

The following properties are defined on the LOV link relation:

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

Back to Top