Get all entities
get
/fscmRestApi/resources/11.13.18.05/publicSectorOpaEntityModels/{EntityModelName}/child/EntityService
Request
Path Parameters
-
EntityModelName(required): string
The name of the entity model.
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:- PrimaryKey: Finds the record that matches the specified primary key criteria.
Finder Variables:- EntityModelName; string; The name of the entity model.
- EntityName; string; The name of the entity.
- SimpleSearchFinder: Finds an entity model that matches the specified keyword.
Finder Variables:- value; string; The keyword used to find an entity that matches the specified entity name or description.
- PrimaryKey: Finds the record that matches the specified primary key criteria.
-
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:- BelongsToTechstack; string; Indicates if the entity belongs to the Technology Stack component. If the value is Y, then it belongs to Technology Stack. The default value is N.
- CanBeInput; string; Indicates if the entity is mapped in as input entity in the Policy Modeler. Valid values are Y or N.
- CanBeOutput; string; Indicates if the entity is mapped out as output entity in the Policy Modeler. Valid values are Y or N.
- CardinalityWithParent; string; Indicates the cardinality of the entity with its parent entity in the associated entity model. Valid values are C_11 for one to one, C_1M for one to many, C_M1 for many to one, C_MN for many to many relationship.
- CreatedBy; string; The name of user who created the entity.
- CreationDate; string; The date on which the entity was created.
- DeletedFlag; string; Indicates if the entity is logically deleted. Valid values are Y for deleted, and N for existing entity. The default value is N.
- Description; string; The description of the entity.
- DynLoadADFVoId; number; The Identifier of the View object associated with the entity from which the default values will be dynamically loaded.
- EntityModelName; string; The name of the entity model that is associated with the entity.
- EntityName; string; The name of the entity.
- IsTopLevel; string; Indicates if the entity is a top level entity in the entity model. If the value is Y, then it is a top level entity. The default value is N.
- LastUpdateDate; string; The date on which the entity was last updated.
- LastUpdatedBy; string; The name of the user who last updated the entity.
- NotificationId; string; The identifier of the notification that is associated with the entity.
- OpaHidden; string; Indicates if the entity is hidden from policy modeling. If the value is Y, then it is a hidden entity. The default value is N.
- OpaLinkName; string; The type if relationship between the entity and its parent entity in the associated entity model.
- OpaName; string; The name as displayed in the Policy Modeler for the entity.
- OwnerId; string; The identifier of the owner who is associated with the entity.
- ParentEoName; string; The name of the parent entity that is associated with the entity.
- SeedDataLock; integer; Indicates if the entity is a seed data. Valid values are 0 for the data that is customer data, 1 for the seed data that cannot be modified, and 2 indicates that the seed data can be modified.
- SupportsAttachment; string; Indicates if the entity supports a collection of attachments. Valid values are Y or N.
- SupportsDynamicLoad; string; Indicates if the entity supports dynamic loading of default values. If the value is Y, then dynamic loading is supported. The default value is N.
- ViewObjectId; integer; The identifier of the View object that is associated with the entity.
-
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 : publicSectorOpaEntityModels-EntityService
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 : publicSectorOpaEntityModels-EntityService-item-response
Type:
Show Source
object
-
BelongsToTechstack: string
Maximum Length:
1
Indicates if the entity belongs to the Technology Stack component. If the value is Y, then it belongs to Technology Stack. The default value is N. -
CanBeInput: string
Title:
Use as Mapped in Entity
Maximum Length:1
Indicates if the entity is mapped in as input entity in the Policy Modeler. Valid values are Y or N. -
CanBeOutput: string
Title:
Use as Mapped Out Entity
Maximum Length:1
Indicates if the entity is mapped out as output entity in the Policy Modeler. Valid values are Y or N. -
CardinalityWithParent: string
Title:
Cardinality with Parent Entity
Maximum Length:5
Indicates the cardinality of the entity with its parent entity in the associated entity model. Valid values are C_11 for one to one, C_1M for one to many, C_M1 for many to one, C_MN for many to many relationship. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The name of user who created the entity. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date on which the entity was created. -
DeletedFlag: string
Maximum Length:
1
Default Value:N
Indicates if the entity is logically deleted. Valid values are Y for deleted, and N for existing entity. The default value is N. -
Description: string
Title:
Description
Maximum Length:100
The description of the entity. -
DynLoadADFVoId: number
The Identifier of the View object associated with the entity from which the default values will be dynamically loaded.
-
EntityModelName: string
Title:
Name
Maximum Length:30
The name of the entity model that is associated with the entity. -
EntityName: string
Title:
Name
Maximum Length:40
The name of the entity. -
IsTopLevel: string
Title:
Top-Level Entity
Maximum Length:1
Indicates if the entity is a top level entity in the entity model. If the value is Y, then it is a top level entity. The default value is N. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date on which the entity was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The name of the user who last updated the entity. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NotificationId: string
Maximum Length:
15
The identifier of the notification that is associated with the entity. -
OpaHidden: string
Title:
Hidden from Policy Modeling
Maximum Length:1
Indicates if the entity is hidden from policy modeling. If the value is Y, then it is a hidden entity. The default value is N. -
OpaLinkName: string
Title:
Policy Modeling Relationship Name
Maximum Length:100
The type if relationship between the entity and its parent entity in the associated entity model. -
OpaName: string
Title:
Policy Modeling Name
Maximum Length:100
The name as displayed in the Policy Modeler for the entity. -
OwnerId: string
Maximum Length:
10
The identifier of the owner who is associated with the entity. -
ParentEoName: string
Title:
Parent Entity Name
Maximum Length:40
The name of the parent entity that is associated with the entity. -
SeedDataLock: integer
(int32)
Default Value:
0
Indicates if the entity is a seed data. Valid values are 0 for the data that is customer data, 1 for the seed data that cannot be modified, and 2 indicates that the seed data can be modified. -
SupportsAttachment: string
Title:
Supports Attachment
Maximum Length:1
Indicates if the entity supports a collection of attachments. Valid values are Y or N. -
SupportsDynamicLoad: string
Title:
Supports Dynamic Default Values
Maximum Length:1
Indicates if the entity supports dynamic loading of default values. If the value is Y, then dynamic loading is supported. The default value is N. -
ViewObjectId: integer
(int64)
Title:
View Object ID
The identifier of the View object that is associated with the entity.
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.