Jump to

• Request
• Response

Get one order representative

get

/fscmRestApi/resources/11.13.18.05/omOrderRepresentativesLOV/{PersonId}

Request

Path Parameters

• PersonId(required): integer
  Unique identifier of the person.

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.

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

Type: object

Show Source

• DisplayName: string
  Title: Order Representative

  Read Only: true

  Maximum Length: 240

  Formatted person's name, with the formatting depending on the Legislation Code. The first name is expected to be the first component in this format.
• EffectiveEndDate: string (date)
  Read Only: true

  Indicates the end date of the date range during which the person is effective.
• EffectiveStartDate: string (date)
  Read Only: true

  Indicates the start date of the date range during which the person is effective.
• EmailAddress: string
  Title: Email

  Read Only: true

  Maximum Length: 240

  E-mail address of the person.
• EmailAddressId: integer (int64)
  Read Only: true

  Unique identifier of the person's e-mail address.
• FirstName: string
  Read Only: true

  Maximum Length: 150

  First name of the person.
• Honors: string
  Read Only: true

  Maximum Length: 80

  A higher qualification that forms part of the person's name.
• KnownAs: string
  Read Only: true

  Maximum Length: 80

  The person's preferred first name.
• LastName: string
  Read Only: true

  Maximum Length: 150

  Last name of the person.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ListName: string
  Read Only: true

  Maximum Length: 240

  The constructed version of a person's name, intended for use in an alphabetically ordered list. The value may differ depending on the Legislation Code. In most cases, the last name is expected to be the first component in this format.
• MiddleNames: string
  Read Only: true

  Maximum Length: 80

  Middle name of the person.
• ObjectVersionNumber: integer (int32)
  Read Only: true

  Object version number for the person record.
• OrderName: string
  Read Only: true

  Maximum Length: 240

  The system-constructed version of the name used for sorting.
• PersonId: integer
  Read Only: true

  Unique identifier of the person.
• PersonNameId: integer (int64)
  Read Only: true

  Unique identifier of the person's name.
• PersonNumber: string
  Read Only: true

  Maximum Length: 30

  A number assigned to the person to uniquely identify them, regardless of their type, such as employee or contingent worker.
• PreNameAdjunct: string
  Read Only: true

  Maximum Length: 150

  Prefix to the person's last name, generally not considered when sorting.
• PrimaryPhoneId: integer (int64)
  Read Only: true

  Unique identifier for the person's phone.
• Suffix: string
  Read Only: true

  Maximum Length: 80

  Part of name appended to the last name.
• Title: string
  Title: Job

  Read Only: true

  Maximum Length: 30

  Name of the job that the person performs in the enterprise.
• UserId: integer (int64)
  Read Only: true

  Unique identifier of the person's fusion application user.
• Username: string
  Title: User Name

  Read Only: true

  Maximum Length: 100

  The latest principal username of the person's fusion application user.

{
    "type":"object",
    "properties":{
        "PersonNumber":{
            "maxLength":30,
            "type":"string",
            "description":"A number assigned to the person to uniquely identify them, regardless of their type, such as employee or contingent worker.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrderName":{
            "maxLength":240,
            "type":"string",
            "description":"The system-constructed version of the name used for sorting.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PreNameAdjunct":{
            "maxLength":150,
            "type":"string",
            "description":"Prefix to the person's last name, generally not considered when sorting.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EffectiveEndDate":{
            "type":"string",
            "description":"Indicates the end date of the date range during which the person is effective.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Honors":{
            "maxLength":80,
            "type":"string",
            "description":"A higher qualification that forms part of the person's name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ListName":{
            "maxLength":240,
            "type":"string",
            "description":"The constructed version of a person's name, intended for use in an alphabetically ordered list. The value may differ depending on the Legislation Code. In most cases, the last name is expected to be the first component in this format.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FirstName":{
            "maxLength":150,
            "type":"string",
            "description":"First name of the person.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "KnownAs":{
            "maxLength":80,
            "type":"string",
            "description":"The person's preferred first name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Title":{
            "title":"Job",
            "maxLength":30,
            "type":"string",
            "description":"Name of the job that the person performs in the enterprise.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"Email",
            "maxLength":240,
            "type":"string",
            "description":"E-mail address of the person.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EmailAddressId":{
            "type":"integer",
            "description":"Unique identifier of the person's e-mail address.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Suffix":{
            "maxLength":80,
            "type":"string",
            "description":"Part of name appended to the last name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonId":{
            "type":"integer",
            "description":"Unique identifier of the person.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Username":{
            "title":"User Name",
            "maxLength":100,
            "type":"string",
            "description":"The latest principal username of the person's fusion application user.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Object version number for the person record.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "UserId":{
            "type":"integer",
            "description":"Unique identifier of the person's fusion application user.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DisplayName":{
            "title":"Order Representative",
            "maxLength":240,
            "type":"string",
            "description":"Formatted person's name, with the formatting depending on the Legislation Code. The first name is expected to be the first component in this format.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastName":{
            "maxLength":150,
            "type":"string",
            "description":"Last name of the person.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EffectiveStartDate":{
            "type":"string",
            "description":"Indicates the start date of the date range during which the person is effective.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryPhoneId":{
            "type":"integer",
            "description":"Unique identifier for the person's phone.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MiddleNames":{
            "maxLength":80,
            "type":"string",
            "description":"Middle name of the person.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonNameId":{
            "type":"integer",
            "description":"Unique identifier of the person's name.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "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."
        }
    }
}

Back to Top