1. REST API for Oracle Supply Chain Management Cloud
  2. Tasks
  3. Supply Chain Planning
  4. Vendor-Managed Inventory Analysts

Get one analyst

get

/fscmRestApi/resources/11.13.18.05/vmiAnalysts/{PersonId}

Request

Path Parameters
  • 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=
Query Parameters
  • 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>
  • 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).
  • 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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
  • 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".
  • 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

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : vmiAnalysts-item-response
Type: object
Show Source
  • Read Only: true
    Maximum Length: 64
    User who created the vendor-managed inventory analyst.
  • Read Only: true
    Date and time when the user created the vendor-managed inventory analyst.
  • Data Access Security
    Title: Data Access Security
    The Data Access Security child resource manages data assess security for the vendor-managed inventory analysts.
  • Title: Name
    Read Only: true
    Maximum Length: 240
    Display name of the user who manages order forecast data in collaboration with suppliers. The format is last name, first name.
  • Title: Email
    Read Only: true
    Maximum Length: 240
    Email address of the user who manages order forecast data in collaboration with suppliers. The service provider uses the canonical form of the email address; for example, j.johnson@example.com.
  • Title: First Name
    Read Only: true
    Maximum Length: 150
    First name of the vendor-managed inventory analyst.
  • Title: Full Access
    Contains one of the following values: Yes or No. If Yes, then the vendor-managed inventory analyst has access to the entire order forecast data. If No, then the vendor-managed inventory analyst doesn't have access to the entire order forecast data. The default value is No.
  • Title: Last Name
    Read Only: true
    Maximum Length: 150
    Last name of the vendor-managed inventory analyst.
  • Read Only: true
    Date and time when the user most recently updated the vendor-managed inventory analyst.
  • Read Only: true
    Maximum Length: 64
    User who most recently updated the vendor-managed inventory analyst.
  • Links
  • Value that uniquely identifies the user who manages order forecast data in collaboration with suppliers.
  • Value that indicates the administrative status of the vendor-managed inventory analyst. The service provider determines the definitive value for this attribute. For example, Active indicates that the vendor-managed inventory analyst can access order forecast data, and Inactive indicates that the vendor-managed inventory analyst can't access order forecast data. The default value is Active.
  • Maximum Length: 30
    Abbreviation that identifies the status of the vendor-managed inventory analyst.
  • Title: UserName
    Maximum Length: 100
    Login that the vendor-managed inventory analyst used to authenticate with the service provider directly. This attribute is required.
Nested Schema : Data Access Security
Type: array
Title: Data Access Security
The Data Access Security child resource manages data assess security for the vendor-managed inventory analysts.
Show Source
Nested Schema : vmiAnalysts-dataAccessSecurity-item-response
Type: object
Show Source
Links
dataAccessSecurity
Parameters:
  • PersonId: $request.path.PersonId
The Data Access Security child resource manages data assess security for the vendor-managed inventory analysts.
Back to Top

Examples

This example describes how to get one analyst.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

curl -u username:password "https://servername/fscmRestApi/resources/version/vmiAnalysts/PersonId"

For example, the following command gets one analyst:

curl -u username:password "https://servername/fscmRestApi/resources/version/vmiAnalysts/300100073658963"

Example Response Body

The following shows an example of the response body in JSON format.

{
    "PersonId": 300100073658963,
    "UserName": "MJones",
    "FirstName": "Matt",
    "LastName": "Jones",
    "DisplayName": "Jones, Matt",
    "Email": "sendmail-test-discard@example.com",
    "Status": "Active",
    "StatusCode": "A",
    "CreatedBy": "ADMIN",
    "CreationDate": "2018-10-25T08:20:12+00:00",
    "LastUpdatedBy": "ADMIN",
    "LastUpdateDate": "2018-10-25T08:20:58.351+00:00",
    "FullAccessFlag": "false",
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/versionvmiAnalysts/300100073658963",
            "name": "vmiAnalysts",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/versionvmiAnalysts/300100073658963",
            "name": "vmiAnalysts",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/versionvmiAnalysts/300100073658963/child/dataAccessSecurity",
            "name": "dataAccessSecurity",
            "kind": "collection"
        }
    ]
}
Back to Top