Get all analysts
get
/fscmRestApi/resources/11.13.18.05/vmiAnalysts
Request
Query Parameters
-
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 -
finder: string
Used as a predefined finder to search the collection.
Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables- PrimaryKey Find vendor-managed inventory analysts according to the primary key.
Finder Variables- PersonId; integer; Value that uniquely identifies the vendor-managed inventory analyst.
- RowFinder Find vendor-managed inventory analysts according to PersonId; integer; .
Finder Variables- PersonId; integer; Value that uniquely identifies the vendor-managed inventory analyst.
- PrimaryKey Find vendor-managed inventory analysts according to the primary key.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
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 -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- CreatedBy; string; User who created the vendor-managed inventory analyst.
- CreationDate; string; Date and time when the user created the vendor-managed inventory analyst.
- DisplayName; string; Display name of the user who manages order forecast data in collaboration with suppliers. The format is last name, first name.
- Email; string; 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.
- FirstName; string; First name of the vendor-managed inventory analyst.
- FullAccessFlag; boolean; 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.
- LastName; string; Last name of the vendor-managed inventory analyst.
- LastUpdateDate; string; Date and time when the user most recently updated the vendor-managed inventory analyst.
- LastUpdatedBy; string; User who most recently updated the vendor-managed inventory analyst.
- PersonId; integer; 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; Abbreviation that identifies the status of the vendor-managed inventory analyst.
- UserName; string; Login that the vendor-managed inventory analyst used to authenticate with the service provider directly. This attribute is required.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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 TopResponse
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
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : vmiAnalysts-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the vendor-managed inventory analyst. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the vendor-managed inventory analyst. -
dataAccessSecurity: array
Data Access Security
Title:
Data Access Security
The Data Access Security child resource manages data assess security for the vendor-managed inventory analysts. -
DisplayName: string
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. -
Email: string
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. -
FirstName: string
Title:
First Name
Read Only:true
Maximum Length:150
First name of the vendor-managed inventory analyst. -
FullAccessFlag: boolean
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. -
LastName: string
Title:
Last Name
Read Only:true
Maximum Length:150
Last name of the vendor-managed inventory analyst. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the vendor-managed inventory analyst. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the vendor-managed inventory analyst. -
links: array
Links
Title:
Links
The 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:
30
Abbreviation that identifies the status of the vendor-managed inventory analyst. -
UserName: string
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : vmiAnalysts-dataAccessSecurity-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the data access security. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the data access security. -
DataAccessId: integer
(int64)
Read Only:
true
Value that uniquely identifies the relationships the vendor-managed inventory analyst has access to. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the data access security. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the data access security. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrganizationCode: string
Abbreviation that identifies the organization that receives the item.
-
OrganizationId: integer
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.
-
OrganizationName: string
Name 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
Value 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
Name of the supplier that ships the item.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Examples
This example describes how to get all analysts.
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"
Example Response Body
The following shows an example of the response body in JSON format.
{ "items": [ { "PersonId": 300100073978964, "UserName": "MJOHNSON", "FirstName": "Mark", "LastName": "Johnson", "DisplayName": "Johnson, Mark", "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", }, ... { } ], "count": 3, "hasMore": false, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/vmiAnalysts", "name": "vmiAnalysts", "kind": "collection" } ] }