Get all catalog resources
get
/fscmRestApi/resources/11.13.18.05/publicSectorApplicationIdTypes/{ResourceId}/child/Catalogs
Request
Path Parameters
-
ResourceId(required): string
The unique identifier for the resource.
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 -
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:- GetOfflineResources: Finds a catalog resource specified by the value of the IsOfflineSupportRequired attribute.
Finder Variables:- isOffline; string; Indicates if offline support is required.
- GetPromptResources: Finds a catalog resource specified by the value of the PromptEnabled attribute.
Finder Variables:- prompt; string; Indicates if a REST resource is prompt-enabled.
- GetQuerysourceResources: Finds a catalog resource specified by the Querysource attribute.
Finder Variables:- querySource; string; Indicates if the resource ID can be used as a primary or related object in a custom query.
- GetReportableResources: Finds a catalog resource specified by the Reportable attribute.
Finder Variables:- reportable; string; Indicates if the resource ID can be used in reporting tools as a data source.
- PrimaryKey: Finds a catalog resource by the primary key criteria.
Finder Variables:- ResourceName; string; The name of the resource.
- GetOfflineResources: Finds a catalog resource specified by the value of the IsOfflineSupportRequired attribute.
-
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; The user who created the row.
- CreationDate; string; The date and time the row was created.
- DeletedFlag; string; 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; string; Indicates if offline support is required.
- IsSearchEnabled; string; Indicates if search is enabled.
- LastUpdateDate; string; The date and time the row was last updated.
- LastUpdateLogin; string; The session login associated with the user who last updated the row.
- LastUpdatedBy; string; The user who last updated the row.
- ModuleId; string; The value is used by 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; integer; 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; string; Indicates if this REST resource is prompt-enabled.
- Querysource; string; Indicates if the resource ID can be used as a primary or a related object in a custom query.
- Reportable; string; Indicates if a resource ID can be used in reporting tools as a data source.
- ResourceId; string; The unique identifier for a resource.
- ResourceName; string; The unique resource name to identify a resource.
- RestEndPoint; string; The REST end point.
- SeedDataLock; integer; 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 delivered seed data that can't be modified, and 2 indicates that the seed data can be modified.
- Version; string; The REST version number.
-
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(required):
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(required):
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 : publicSectorApplicationIdTypes-Catalogs
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 : publicSectorApplicationIdTypes-Catalogs-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the row. -
CreationDate: string
(date-time)
Read Only:
true
The date and time the row was created. -
DeletedFlag: string
Maximum Length:
1
Default Value:N
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: string
Maximum Length:
1
Indicates if offline support is required. -
IsSearchEnabled: string
Maximum Length:
1
Indicates if search is enabled. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time the row was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the row. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The session login associated with the user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ModuleId: string
Maximum Length:
32
The value is used by 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: 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: string
Maximum Length:
1
Indicates if this REST resource is prompt-enabled. -
Querysource: string
Maximum Length:
1
Indicates if the resource ID can be used as a primary or a related object in a custom query. -
Reportable: string
Maximum Length:
1
Indicates if a resource ID can be used in reporting tools as a data source. -
ResourceId: string
Maximum Length:
50
The unique identifier for a resource. -
ResourceName: string
Maximum Length:
256
The unique resource name to identify a resource. -
RestEndPoint: string
Maximum Length:
1000
The REST end point. -
SeedDataLock: integer
(int32)
Default Value:
1
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 delivered seed data that can't be modified, and 2 indicates that the seed data can be modified. -
Version: string
Maximum Length:
20
The REST version number.
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.
Links
- getEndPointForResourceNames
-
Parameters:
- ResourceId:
$request.path.ResourceId
- ResourceId: