Get one data access security
get
/fscmRestApi/resources/11.13.18.05/collaborationPlanners/{PersonId}/child/dataAccessSecurity/{dataAccessSecurityUniqID}
Request
Path Parameters
-
PersonId(required): integer(int64)
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=
-
dataAccessSecurityUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Data Access Security resource and used to uniquely identify an instance of Data Access Security. The client should not generate the hash key value. Instead, the client should query on the Data Access Security collection resource in order to navigate to a specific instance of Data Access Security to get the hash key.
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:
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 : collaborationPlanners-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 data access security of the collaboration planner. -
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: string
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.
-
ProcurementBUId: integer
Value that uniquely identifies the procurement business unit. It's a primary key that the application creates when it creates the business unit.
-
ProcurementBUName: string
Name of the business unit. The application assigns the supplier site to this business unit.
-
SecurityContext: string
Title:
Security Context
Value that identifies the level of security applied. Values include supplier or supplier site. -
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.
-
ShipFromSupplierId: 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.
-
ShipFromSupplierName: string
Name of the supplier that ships the item.
-
ShipFromSupplierSiteId: integer
Value that uniquely identifies the supplier site who ships the item. It's a primary key that the application creates when it creates the supplier site.
-
ShipFromSupplierSiteName: string
Name of the supplier site that ships the item.
-
SourceSystem: string
Title:
Source System
Value that indicates the product data model source system for the supply plan that's available for supply chain collaboration. Values include External or Oracle. -
SourceSystemCode: string
Abbreviation that indicates the product data model source system for the supply plan that's available for supply chain collaboration. Values include ORA_VCS_SRCSYSTEM_EXTERNAL or ORA_VCS_SRCSYSTEM_ORACLE.
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 one data access security.
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/collaborationPlanners/PersonId/child/dataAccessSecurity//DataAccessId"
For example, the following command gets one data access security where the data access identifier is 300100120934687:
curl -u username:password "https://servername/fscmRestApi/resources/version/collaborationPlanners/PersonId/child/dataAccessSecurity/300100120934687"
Example Response Body
The following shows an example of the response body in JSON format.
{ "DataAccessId": 300100120934687, "SecurityContext": "Supplier Site", "ShipFromSupplierId": 416, "ShipFromSupplierName": "Little Chips", "ShipFromSupplierSiteId": 1395, "ShipFromSupplierSiteName": "Atlanta", "ProcurementBUId": 204, "ProcurementBUName": "Vision Corporation", "CreatedBy": "AdminUser", "CreationDate": "2017-07-27T01:12:06.202+00:00", "LastUpdatedBy": "AdminUser", "LastUpdateDate": "2017-07-27T01:12:42.944+00:00" }