Create analysts
post
/fscmRestApi/resources/11.13.18.05/vmiAnalysts
Request
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.
-
Upsert-Mode:
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
- application/json
Root Schema : schema
Type:
Show Source
object-
dataAccessSecurity: array
Data Access Security
Title:
Data Access SecurityThe Data Access Security child resource manages data assess security for the vendor-managed inventory analysts. -
FullAccessFlag: boolean
Title:
Full AccessContains 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. -
PersonId: integer
(int64)
Value that uniquely identifies the user who manages order forecast data in collaboration with suppliers.
-
Status: string
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.
-
StatusCode: string
Maximum Length:
30Abbreviation that identifies the status of the vendor-managed inventory analyst. -
UserName: string
Title:
UserNameMaximum Length:100Login that the vendor-managed inventory analyst used to authenticate with the service provider directly. This attribute is required.
Nested Schema : Data Access Security
Type:
arrayTitle:
Data Access SecurityThe Data Access Security child resource manages data assess security for the vendor-managed inventory analysts.
Show Source
Nested Schema : schema
Type:
Show Source
object-
OrganizationCode: string
Abbreviation that identifies the organization that receives the item.
-
OrganizationId: integer
Title:
OrganizationValue that uniquely identifies the organization. This organization receives the shipment. It's a primary key that the application creates when it creates an organization. -
OrganizationName: string
Title:
OrganizationName of the organization that receives the item. -
SecurityContext: string
Value that identifies the level of security applied. Values include Supplier or Supplier Site. The default value is Supplier.
-
SecurityContextCode: string
Value that identifies the level of security applied. A list of accepted values is defined in the lookup type ORA_VCS_SECURITY_CONTEXT.
-
SupplierId: integer
Title:
SupplierValue that uniquely identifies the supplier who ships the item. It's a primary key that the application creates when it creates the supplier. -
SupplierName: string
Title:
SupplierName of the supplier that ships the item.
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.
Root Schema : vmiAnalysts-item-response
Type:
Show Source
object-
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the vendor-managed inventory analyst. -
CreationDate: string
(date-time)
Read Only:
trueDate and time when the user created the vendor-managed inventory analyst. -
dataAccessSecurity: array
Data Access Security
Title:
Data Access SecurityThe Data Access Security child resource manages data assess security for the vendor-managed inventory analysts. -
DisplayName: string
Title:
NameRead Only:trueMaximum Length:240Display name of the user who manages order forecast data in collaboration with suppliers. The format is last name, first name. -
Email: string
Title:
EmailRead Only:trueMaximum Length:240Email 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. -
FirstName: string
Title:
First NameRead Only:trueMaximum Length:150First name of the vendor-managed inventory analyst. -
FullAccessFlag: boolean
Title:
Full AccessContains 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. -
LastName: string
Title:
Last NameRead Only:trueMaximum Length:150Last name of the vendor-managed inventory analyst. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate and time when the user most recently updated the vendor-managed inventory analyst. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the vendor-managed inventory analyst. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PersonId: integer
(int64)
Value that uniquely identifies the user who manages order forecast data in collaboration with suppliers.
-
Status: string
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.
-
StatusCode: string
Maximum Length:
30Abbreviation that identifies the status of the vendor-managed inventory analyst. -
UserName: string
Title:
UserNameMaximum Length:100Login that the vendor-managed inventory analyst used to authenticate with the service provider directly. This attribute is required.
Nested Schema : Data Access Security
Type:
arrayTitle:
Data Access SecurityThe Data Access Security child resource manages data assess security for the vendor-managed inventory analysts.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : vmiAnalysts-dataAccessSecurity-item-response
Type:
Show Source
object-
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the data access security. -
CreationDate: string
(date-time)
Read Only:
trueDate and time when the user created the data access security. -
DataAccessId: integer
(int64)
Read Only:
trueValue that uniquely identifies the relationships the vendor-managed inventory analyst has access to. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate and time when the user most recently updated the data access security. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the data access security. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
OrganizationCode: string
Abbreviation that identifies the organization that receives the item.
-
OrganizationId: integer
Title:
OrganizationValue that uniquely identifies the organization. This organization receives the shipment. It's a primary key that the application creates when it creates an organization. -
OrganizationName: string
Title:
OrganizationName of the organization that receives the item. -
SecurityContext: string
Value that identifies the level of security applied. Values include Supplier or Supplier Site. The default value is Supplier.
-
SecurityContextCode: string
Value that identifies the level of security applied. A list of accepted values is defined in the lookup type ORA_VCS_SECURITY_CONTEXT.
-
SupplierId: integer
Title:
SupplierValue that uniquely identifies the supplier who ships the item. It's a primary key that the application creates when it creates the supplier. -
SupplierName: string
Title:
SupplierName of the supplier that ships the item.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- dataAccessSecurity
-
Parameters:
- PersonId:
$request.path.PersonId
The Data Access Security child resource manages data assess security for the vendor-managed inventory analysts. - PersonId:
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"
}