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

Create analysts

post

/fscmRestApi/resources/11.13.18.05/vmiAnalysts

Request

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.
  • Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Data Access Security
    Title: Data Access Security
    The Data Access Security child resource manages data assess security for the vendor-managed inventory analysts.
  • 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.
  • 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 : schema
Type: object
Show Source
  • Abbreviation that identifies the organization that receives the item.
  • Title: Organization
    Value that uniquely identifies the organization. This organization receives the shipment. It's a primary key that the application creates when it creates an organization.
  • Title: Organization
    Name of the organization that receives the item.
  • Value that identifies the level of security applied. Values include Supplier or Supplier Site. The default value is Supplier.
  • Value that identifies the level of security applied. A list of accepted values is defined in the lookup type ORA_VCS_SECURITY_CONTEXT.
  • Title: Supplier
    Value that uniquely identifies the supplier who ships the item. It's a primary key that the application creates when it creates the supplier.
  • Title: Supplier
    Name of the supplier that ships the item.
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 create analysts.

Example cURL Command

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

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version/vmiAnalysts"

Example Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates. 

{
"UserName": "SSmith",
"StatusCode": "A",
"FullAccessFlag": "True"
}

Example Response Body

The following example includes the contents of the response body in JSON format:

{
      "PersonId": 300100104078020,
      "UserName": "SSmith",
      "FirstName": "Steve",
      "LastName": "Smith",
      "DisplayName": "Smith, Steve",
      "Email": "ssmith@example.com",
      "StatusCode": "A",
      "Status": "Active",
      "CreatedBy": "ADMIN",
      "CreationDate": "2018-06-25T15:48:53+00:00",
      "LastUpdatedBy": "ADMIN",
      "LastUpdateDate": "2018-06-25T15:48:53.789+00:00",
      "FullAccessFlag": "true"
}
Back to Top