1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Product Lifecycle Management
  4. Product Management Data Securities

Get all grants

get

/fscmRestApi/resources/11.13.18.05/productManagementDataSecurities

Request

Query Parameters
  • 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).
  • 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
  • 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

    • ItemClassAltKey Find item classes according to the alternate key.
      Finder Variables
      • ItemClass; string; Name; string; of the item class used to identify the context of the data grant. This attribute is part of an alternate key that includes ItemClassAltKey.
      • Name; string; Name; string; of the person or group in the data grant. This attribute is part of an alternate key that includes ItemClassAltKey.
      • ObjectName; string; Name; string; of the object for the data grant. This attribute is part of alternate key that includes ItemClassAltKey.
      • OrganizationCode; string; Abbreviation that identifies the organization for the data grant. This attribute is part of an alternate key that includes ItemClassAltKey.
      • Principal; string; User or group for the data grant. This attribute is part of an alternate key that includes ItemClassAltKey.
    • ItemNumberAltKey Find items according to the alternate key.
      Finder Variables
      • ItemNumber; string; Number that identifies the item used in a data grant. This attribute is part of an alternate key that includes ItemNumberAltKey.
      • Name; string; Name; string; of the person or group in the data grant. This attribute is part of an alternate key that includes ItemNumberAltKey.
      • ObjectName; string; Name; string; of the object for the data grant. This attribute is part of alternate key that includes ItemNumberAltKey.
      • OrganizationCode; string; Abbreviation that identifies the organization for the data grant. This attribute is part of an alternate key that includes ItemNumberAltKey.
      • Principal; string; User or group for the data grant. This attribute is part of an alternate key that includes ItemNumberAltKey.
    • PrimaryKey Find data security grants according to the primary key criteria.
      Finder Variables
      • GrantId; string; Value that uniquely identifies the data grant.
      • ObjectName; string; Name; string; of object for the data grant.
    • TradingPartnerAltKey Find trading partner according to the alternate key.
      Finder Variables
      • Name; string; Name; string; of the person or group in the data grant. This attribute is part of an alternate key that includes TradingParnterAltKey.
      • ObjectName; string; Name; string; of the object for the data grant. This attribute is part of alternate key that includes TradingPartnerAltKey.
      • Principal; string; User or group for the data grant. This attribute is part of an alternate key that includes TradingParnterAltKey.
      • TradingPartnerItemType; string; Type of trading partner items. This attribute is part of an alternate key that includes TradingParnterAltKey.
      • TradingPartnerName; string; Name; string; of trading partner in a data grant. This attribute is part of an alternate key that includes TradingParnterAltKey.
    • TradingPartnerItemAltKey Find trading partner items according to the alternate key.
      Finder Variables
      • Name; string; Name; string; of the person or group in the data grant. This attribute is part of an alternate key that includes TradingParnterItemAltKey.
      • ObjectName; string; Name; string; of the object for the data grant. This attribute is part of alternate key that includes TradingParnterItemAltKey.
      • Principal; string; User or group for the data grant. This attribute is part of an alternate key that includes TradingParnterItemAltKey.
      • TradingPartnerItemNumber; string; Number that identifies the trading partner item. This attribute is part of an alternate key that includes TradingParnterItemAltKey.
      • TradingPartnerItemType; string; Type of trading partner items. This attribute is part of an alternate key that includes TradingParnterItemAltKey.
      • TradingPartnerName; string; Name; string; of trading partner in a data grant. This attribute is part of an alternate key that includes TradingParnterItemAltKey.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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:
    • ChangeOrderNumber; string; Number that identifies the item change order used in a 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.
    • ItemClass; string; Name of the item class used to identify the context of the data grant.
    • ItemNumber; string; Number that identifies the item used in a data grant.
    • 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.
    • Principal; string; User or group for the data grant.
    • 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.
  • 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
  • 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.

There's no request body for this operation.

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 : productManagementDataSecurities
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : productManagementDataSecurities-item-response
Type: object
Show Source
Nested Schema : PmItemDetailsPVO
Type: array
Show Source
Nested Schema : productManagementDataSecurities-PmItemDetailsPVO-item-response
Type: object
Show Source
Links
secureObject
Transitions the data security state of the object to a private state, which requires data security for access.
Back to Top

Examples

This example describes how to get all grants.

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"

Example 1

For example, the following command gets all instance set data grants for user JAMES for the items in the item class "Root Item Class" and org V1:

curl -u username:password "https://servername/fscmRestApi/resources/version/productManagementDataSecurities?q=ObjectName=Item;Principal=Person;Name=JAMES;ItemClass="Root Item Class";OrganizationCode=V"

Example 1 Response Body

The following shows an example of the response body in JSON format.

 "items": [
    {
      "ObjectName": "Item",
      "GrantId": "81C5D0A1AEA21255E053A15AF00ACA18",
      "InstanceType": "SET",
      "Principal": "Person",
      "Name": "PIMQA",
      "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 2

For example, the following command gets all instance data grants for person JAMES for item number "AS123" in organization V1:

curl -u username:password "https://servername/fscmRestApi/resources/version/productManagementDataSecurities?q=ObjectName=Item;Principal=Person;Name=JAMES;ItemNumber=AS123;OrganizationCode=V1"

Example 2 Response Body

The following shows an example of the response body in JSON format.

 "items": [
    {
      "ObjectName": "Item",
      "GrantId": "90309F0A6E646265E05321BDF20A5839",
      "InstanceType": "INSTANCE",
      "Principal": "Person",
      "Name": "PIMQA",
      "Description": null,
      "StartDate": "2019-08-15",
      "EndDate": null,
      "OrganizationCode": "V1",
      "ItemClass": null,
      "InheritedItemClass": null,
      "ItemNumber": "gabe_root_01",
      "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 3

For example, the following command gets all instance set trading partner item grants for user LARRY for trading partner "World of Business" of type Competitor:

curl -u username:password "https://servername/fscmRestApi/resources/version/productManagementDataSecurities?q=ObjectName="Trading Partner Item";Principal=Person;Name=PIMQA_KO;TradingPartnerItemType=Competitor;TradingPartnerName="World of Business"

Example 3 Response Body

The following shows an example of the response body in JSON format.

  "items": [
    {
      "ObjectName": "Trading Partner Item",
      "GrantId": "937A16DDE67A6273E05321BDF20A18B1",
      "InstanceType": "SET",
      "Principal": "Person",
      "Name": "LARRY",
      "Description": "gtp_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,
  }, {
...
  } ],
...
}

Example 4

For example, the following command gets all instance trading partner item grants for user LARRY for trading partner "World of Business" of type Competitor and TP Item "tpi_01":

curl -u username:password "https://servername/fscmRestApi/resources/version/productManagementDataSecurities?q=ObjectName="Trading Partner Item";Principal=Person;Name=CVBUYER01;TradingPartnerItemType=Competitor;TradingPartnerName="World of Business";TradingPartnerItemNumber=gabe_tpi_01"

Example 4 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,
  }, {
...
  } ],
...
}
Back to Top