Get one grant
/fscmRestApi/resources/11.13.18.05/productManagementDataSecurities/{productManagementDataSecuritiesUniqID}
Request
-
productManagementDataSecuritiesUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Product Management Data Securities resource and used to uniquely identify an instance of Product Management Data Securities. The client should not generate the hash key value. Instead, the client should query on the Product Management Data Securities collection resource in order to navigate to a specific instance of Product Management Data Securities to get the hash key.
-
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).
-
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
- application/json
Default Response
-
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.
object
-
Actions: string
Value that indicates the privileges assigned to a user or group.
-
ChangeOrderNumber: string
Number that identifies the item change order used in a data grant.
-
Description: string
Description of the data security grant.
-
EndDate: string
(date)
Date when the data security grant is no longer applicable.
-
GrantId: string
Value that uniquely identifies the data grant.
-
InheritedFlag: boolean
Contains one of the following values: true or false. If true, then the data security grant is inherited. If false, then the data security grant isn't inherited. The default value is false.
-
InheritedItemClass: string
Name of the item class for the inherited data grant.
-
InstanceType: string
Type of data security grant.
-
ItemClass: string
Name of the item class used to identify the context of the data grant.
-
ItemEFFActions: string
Value that indicates the privileges assigned to a user or group for item extensible flexfields.
-
ItemEFFTranslationActions: string
Value that indicates the privileges assigned to a user or group for translated item extensible flexfields.
-
ItemNumber: string
Number that identifies the item used in a data grant.
-
ItemRevisionEFFActions: string
Value that indicates the privileges assigned to a user or group for item revision extensible flexfields.
-
ItemRevisionEFFTranslationActions: string
Value that indicates the privileges assigned to a user or group for translated item revision extensible flexfields.
-
ItemSupplierEFFActions: string
Value that indicates the privileges assigned to a user or group for item supplier extensible flexfields.
-
ItemSupplierEFFTranslationActions: string
Value that indicates the privileges assigned to a user or group for translated item supplier extensible flexfields.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Name of the person or group in the data grant.
-
ObjectName: string
Name of the object for the data grant.
-
OrganizationCode: string
Abbreviation that identifies the organization for the data grant.
-
PmItemDetailsPVO: array
PmItemDetailsPVO
-
Principal: string
User or group for the data grant.
-
StartDate: string
(date)
Date from when the data grant is valid.
-
TradingPartnerItemNumber: string
Number that identifies the trading partner item in a data grant.
-
TradingPartnerItemType: string
Type of trading partner items.
-
TradingPartnerName: string
Name of trading partner in a data grant.
array
Links
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.
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
object
-
InventoryItemId: integer
(int64)
Read Only:
true
-
InventoryOrganizationId: integer
(int64)
Read Only:
true
-
ItemCatalogGroupId: integer
(int64)
Read Only:
true
-
ItemNumber: string
Read Only:
true
Maximum Length:300
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrganizationId: integer
(int64)
Read Only:
true
-
PublicFlag: boolean
Read Only:
true
Maximum Length:1
array
Links
- PmItemDetailsPVO
-
Parameters:
- productManagementDataSecuritiesUniqID:
$request.path.productManagementDataSecuritiesUniqID
- productManagementDataSecuritiesUniqID:
Examples
This example describes how to get one cost adjustment.
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/productManagementDataSecurities/productManagementDataSecuritiesUniqID"
Example 1 cURL Command
For example, the following command gets one instance item data grant for item AS123 in Organization V1, for user LARRY:
curl -u username:password "https://servername/fscmRestApi/resources/version/productManagementDataSecurities?q=ObjectName=Item;ItemNumber=AS123;OrganizationCode=V1;Principal=Person;Name=LARRY"
Example 1 Response Body
The following shows an example of the response body in JSON format.
"items": [ { "ObjectName": "Item", "GrantId": "90309F0A6E646265E05321BDF20A5839", "InstanceType": "INSTANCE", "Principal": "Person", "Name": "LARRY", "Description": null, "StartDate": "2019-08-15", "EndDate": null, "OrganizationCode": "V1", "ItemClass": null, "InheritedItemClass": null, "ItemNumber": "AS123", "InheritedFlag": "false", "TradingPartnerName": null, "TradingPartnerItemType": null, "TradingPartnerItemNumber": null, "Actions": "Delete | Maintain Item Asset Maintenance Group | Maintain Item Attribute | Maintain Item Basic | Maintain Item Costing Group | Maintain Item General Planning Group | Maintain Item Inventory Group | Maintain Item Invoicing Group | Maintain Item Lead Times Group | Maintain Item MRP and MPS Group | Maintain Item Order Management Group | Maintain Item Pack | Maintain Item People | Maintain Item Physical Group | Maintain Item Primary Group | Maintain Item Process Manufacturing Group | Maintain Item Purchasing Group | Maintain Item Receiving Group | Maintain Item Revision | Maintain Item Service Group | Maintain Item Structure | Maintain Item Structure Group | Maintain Item Web Option Group | Maintain Item Work in Process Group | Read | Update | View Item Attribute | View Item Basic | View Item Pack | View Item Structure", "ItemEFFActions": null, "ItemEFFTranslationActions": null, "ItemRevisionEFFActions": null, "ItemRevisionEFFTranslationActions": null, "ItemSupplierEFFActions": null, "ItemSupplierEFFTranslationActions": null, ... } ]
Example 2 cURL Command
For example, the following command gets one instance set item data grant for Item Class Electronics for user LARRY in Organization V1:
curl -u username:password "https://servername/fscmRestApi/resources/version/productManagementDataSecurities?q=ObjectName=Item;OrganizationCode=V1;ItemClass=Electronics;Principal=Person;Name=LARRY"
Example 2 Response Body
The following shows an example of the response body in JSON format.
"items": [ { "ObjectName": "Item", "GrantId": "81C5D0A1AEA21255E053A15AF00ACA18", "InstanceType": "SET", "Principal": "Person", "Name": "LARRY", "Description": null, "StartDate": "2017-07-21", "EndDate": null, "OrganizationCode": "V1", "ItemClass": "Root Item Class", "InheritedItemClass": "Root Item Class", "ItemNumber": null, "InheritedFlag": "false", "TradingPartnerName": null, "TradingPartnerItemType": null, "TradingPartnerItemNumber": null, "Actions": "Create Item Class Item | Delete | Maintain Item Asset Maintenance Group | Maintain Item Attribute | Maintain Item Basic | Maintain Item Costing Group | Maintain Item General Planning Group | Maintain Item Inventory Group | Maintain Item Invoicing Group | Maintain Item Lead Times Group | Maintain Item MRP and MPS Group | Maintain Item Order Management Group | Maintain Item Pack | Maintain Item People | Maintain Item Physical Group | Maintain Item Primary Group | Maintain Item Process Manufacturing Group | Maintain Item Purchasing Group | Maintain Item Receiving Group | Maintain Item Revision | Maintain Item Service Group | Maintain Item Structure | Maintain Item Structure Group | Maintain Item Web Option Group | Maintain Item Work in Process Group | Read | Update | View Item Attribute | View Item Basic | View Item Pack | View Item Structure", "ItemEFFActions": null, "ItemEFFTranslationActions": null, "ItemRevisionEFFActions": null, "ItemRevisionEFFTranslationActions": null, "ItemSupplierEFFActions": null, "ItemSupplierEFFTranslationActions": null, } ]
Example 3 cURL Command
For example, the following command gets one instance trading partner item data grant for trading partner item type competitor, for trading partner World of Business, for trading partner item number tpi_01, for user LARRY:
curl -u username:password "https://servername/fscmRestApi/resources/version/productManagementDataSecurities?q=ObjectName="Trading Partner Item";Principal=Person;Name=LARRY;TradingPartnerItemType=Competitor;TradingPartnerName="World of Business";TradingPartnerItemNumber=tpi_01"
Example 3 Response Body
The following shows an example of the response body in JSON format.
"items": [ { "ObjectName": "Trading Partner Item", "GrantId": "92C65F5E69A40784E05321BDF20ABED2", "InstanceType": "INSTANCE", "Principal": "Person", "Name": "LARRY", "Description": "tp_grant", "StartDate": "2019-09-17", "EndDate": null, "OrganizationCode": null, "ItemClass": null, "InheritedItemClass": null, "ItemNumber": null, "InheritedFlag": "false", "TradingPartnerName": "World of Business", "TradingPartnerItemType": "Competitor", "TradingPartnerItemNumber": "tpi_01", "Actions": "Read | Update", "ItemEFFActions": null, "ItemEFFTranslationActions": null, "ItemRevisionEFFActions": null, "ItemRevisionEFFTranslationActions": null, "ItemSupplierEFFActions": null, "ItemSupplierEFFTranslationActions": null, }, { ... } ], ... }
Example 4 cURL Command
For example, the following command gets one instance set trading partner grants for user LARRY for trading partner "World of Business" of trading partner item type of Competitor:
curl -u username:password "https://servername/fscmRestApi/resources/version/productManagementDataSecurities?q=ObjectName="Trading Partner Item";Principal=Person;Name=LARRY;TradingPartnerItemType=Competitor;TradingPartnerName="World of Business"
Example 4 Response Body
The following shows an example of the response body in JSON format.
{ "ObjectName": "Trading Partner Item", "GrantId": "937A16DDE67A6273E05321BDF20A18B1", "InstanceType": "SET", "Principal": "Person", "Name": "LARRY", "Description": "tp_grant", "StartDate": "2019-09-10", "EndDate": "2019-09-20", "OrganizationCode": null, "ItemClass": null, "InheritedItemClass": null, "ItemNumber": null, "InheritedFlag": null, "TradingPartnerName": "World of Business", "TradingPartnerItemType": "Competitor", "TradingPartnerItemNumber": null, "Actions": "Administrate Trading Partner Item | Read | Update", "ItemEFFActions": null, "ItemEFFTranslationActions": null, "ItemRevisionEFFActions": null, "ItemRevisionEFFTranslationActions": null, "ItemSupplierEFFActions": null, "ItemSupplierEFFTranslationActions": null, }