Get a catalog resource
get
/fscmRestApi/resources/11.13.18.05/publicSectorCatalogResources/{ResourceName}
Request
Path Parameters
-
ResourceName: string
The name of the resource.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes 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 attributes 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 attributes. 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 attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes 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 attributes. 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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorCatalogResources-item
Type:
Show Source
object
-
CreatedBy(optional):
string
Maximum Length:
64
The user who created the row. -
CreationDate(optional):
string(date-time)
The date and time the row was created.
-
DeletedFlag(optional):
string
Maximum Length:
1
Indicates whether the record is logically deleted (Y or N). Valid values are Y for a deleted record, and N for an active record. The default value is N. -
IsOfflineSupportRequired(optional):
string
Maximum Length:
1
Indicates if offline support is required. -
IsSearchEnabled(optional):
string
Maximum Length:
1
Indicates if search is enabled. -
LastUpdateDate(optional):
string(date-time)
The date and time the row was last updated.
-
LastUpdatedBy(optional):
string
Maximum Length:
64
The user who last updated the row. -
LastUpdateLogin(optional):
string
Maximum Length:
32
The session login associated with the user who last updated the row. -
links(optional):
array Items
Title:
Items
Link Relations -
ModuleId(optional):
string
Maximum Length:
32
The value is used by the Seed Data Framework and indicates the module that owns the row. A module is an entry in Application Taxonomy, such as a Logical Business Area. When the MODULE_ID column exists and the owner of the row is not specified, then the Seed Data Framework will not extract the row as seed data. -
ObjectVersionNumber(optional):
integer(int32)
The number used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
-
PromptEnabled(optional):
string
Maximum Length:
1
Indicates if this REST resource is prompt-enabled. -
Querysource(optional):
string
Maximum Length:
1
Indicates if the resource ID can be used as a primary or a related object in a custom query. -
Reportable(optional):
string
Maximum Length:
1
Indicates if resource ID can be used in reporting tools as a data source. -
ResourceId(optional):
string
Maximum Length:
50
The unique identifier of a resource. -
ResourceName(optional):
string
Maximum Length:
256
The name of the resource. -
RestEndPoint(optional):
string
Maximum Length:
1000
The REST end point. -
SeedDataLock(optional):
integer(int32)
The number used to indicate whether the row is delivered seed data or customer data. Valid values are 0 for data that is customer data, 1 for seed data that can't be modified, and 2 indicates that the seed data can be modified.
-
Version(optional):
string
Maximum Length:
20
The REST version number.
Nested Schema : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.