Jump to

• Request
• Response

Get all entities

get

/fscmRestApi/resources/11.13.18.05/publicSectorOpaEntityModels/{EntityModelName}/child/EntityService

Request

Path Parameters

• EntityModelName: string
  The name of the entity model.

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
• 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:
  
  

  • 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. Finder Variables:
    • EntityModelName; string; The name of the entity model.
    • EntityName; string; The name of the entity.
• 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.
• 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 attributes. 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
• 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".

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourcecollection+json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorOpaEntityModels-EntityService

Type: object

Show Source

• count(optional): integer
  Title: Count

  The number of resource instances returned in the current range.
• hasMore(optional): boolean
  Title: HasMore

  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(optional): array Items
  Title: Items

  The items in the collection.
• limit(optional): integer
  Title: Limit

  The actual paging size used by the server.
• links(optional): array Items
  Title: Items

  The link relations associated with the resource instance.
• offset(optional): integer
  Title: Offset

  The offset value used in the current page.

{
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range.",
            "title":"Count"
        },
        "hasMore":{
            "type":"boolean",
            "description":"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.",
            "title":"HasMore"
        },
        "items":{
            "items":{
                "$ref":"#/definitions/publicSectorOpaEntityModels-EntityService-item"
            },
            "type":"array",
            "description":"The items in the collection.",
            "title":"Items"
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server.",
            "title":"Limit"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "title":"Items"
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page.",
            "title":"Offset"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object publicSectorOpaEntityModels-EntityService-item

{
    "items":{
        "$ref":"#/definitions/publicSectorOpaEntityModels-EntityService-item"
    },
    "type":"array",
    "description":"The items in the collection.",
    "title":"Items"
}

Nested Schema : Items

Type: array

Title: Items

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "title":"Items"
}

Nested Schema : publicSectorOpaEntityModels-EntityService-item

Type: object

Show Source

• BelongsToTechstack(optional): 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(optional): 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(optional): 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(optional): 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(optional): string
  Title: Created By

  Maximum Length: 64

  The name of user who created the entity.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date on which the entity was created.
• DeletedFlag(optional): string
  Maximum Length: 1

  Indicates if the entity is logically deleted. Valid values are Y for deleted, and N for existing entity. The default value is N.
• Description(optional): string
  Title: Description

  Maximum Length: 100

  The description of the entity.
• DynLoadADFVoId(optional): number
  The Identifier of the View object associated with the entity from which the default values will be dynamically loaded.
• EntityModelName(optional): string
  Title: Name

  Maximum Length: 30

  The name of the entity model that is associated with the entity.
• EntityName(optional): string
  Title: Name

  Maximum Length: 40

  The name of the entity.
• IsTopLevel(optional): 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(optional): string(date-time)
  Title: Last Updated Date

  The date on which the entity was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The name of the user who last updated the entity.
• links(optional): array Items
  Title: Items

  Link Relations
• NotificationId(optional): string
  Maximum Length: 15

  The identifier of the notification that is associated with the entity.
• OpaHidden(optional): 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(optional): 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(optional): string
  Title: Policy Modeling Name

  Maximum Length: 100

  The name as displayed in the Policy Modeler for the entity.
• OwnerId(optional): string
  Maximum Length: 10

  The identifier of the owner who is associated with the entity.
• ParentEoName(optional): string
  Title: Parent Entity Name

  Maximum Length: 40

  The name of the parent entity that is associated with the entity.
• SeedDataLock(optional): integer(int32)
  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(optional): string
  Title: Supports Attachment

  Maximum Length: 1

  Indicates if the entity supports a collection of attachments. Valid values are Y or N.
• SupportsDynamicLoad(optional): 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(optional): integer(int64)
  Title: View Object ID

  The identifier of the View object that is associated with the entity.

{
    "properties":{
        "BelongsToTechstack":{
            "maxLength":1,
            "type":"string",
            "description":"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":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the entity is mapped in as input entity in the Policy Modeler. Valid values are Y or N.",
            "title":"Use as Mapped in Entity"
        },
        "CanBeOutput":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the entity is mapped out as output entity in the Policy Modeler. Valid values are Y or N.",
            "title":"Use as Mapped Out Entity"
        },
        "CardinalityWithParent":{
            "maxLength":5,
            "type":"string",
            "description":"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.",
            "title":"Cardinality with Parent Entity"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of user who created the entity.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date on which the entity was created.",
            "title":"Creation Date"
        },
        "DeletedFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the entity is logically deleted. Valid values are Y for deleted, and N for existing entity. The default value is N."
        },
        "Description":{
            "maxLength":100,
            "type":"string",
            "description":"The description of the entity.",
            "title":"Description"
        },
        "DynLoadADFVoId":{
            "type":"number",
            "description":"The Identifier of the View object associated with the entity from which the default values will be dynamically loaded."
        },
        "EntityModelName":{
            "maxLength":30,
            "type":"string",
            "description":"The name of the entity model that is associated with the entity.",
            "title":"Name"
        },
        "EntityName":{
            "maxLength":40,
            "type":"string",
            "description":"The name of the entity.",
            "title":"Name"
        },
        "IsTopLevel":{
            "maxLength":1,
            "type":"string",
            "description":"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.",
            "title":"Top-Level Entity"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date on which the entity was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the entity.",
            "title":"Last Updated By"
        },
        "NotificationId":{
            "maxLength":15,
            "type":"string",
            "description":"The identifier of the notification that is associated with the entity."
        },
        "OpaHidden":{
            "maxLength":1,
            "type":"string",
            "description":"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.",
            "title":"Hidden from Policy Modeling"
        },
        "OpaLinkName":{
            "maxLength":100,
            "type":"string",
            "description":"The type if relationship between the entity and its parent entity in the associated entity model.",
            "title":"Policy Modeling Relationship Name"
        },
        "OpaName":{
            "maxLength":100,
            "type":"string",
            "description":"The name as displayed in the Policy Modeler for the entity.",
            "title":"Policy Modeling Name"
        },
        "OwnerId":{
            "maxLength":10,
            "type":"string",
            "description":"The identifier of the owner who is associated with the entity."
        },
        "ParentEoName":{
            "maxLength":40,
            "type":"string",
            "description":"The name of the parent entity that is associated with the entity.",
            "title":"Parent Entity Name"
        },
        "SeedDataLock":{
            "format":"int32",
            "type":"integer",
            "description":"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":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the entity supports a collection of attachments. Valid values are Y or N.",
            "title":"Supports Attachment"
        },
        "SupportsDynamicLoad":{
            "maxLength":1,
            "type":"string",
            "description":"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.",
            "title":"Supports Dynamic Default Values"
        },
        "ViewObjectId":{
            "format":"int64",
            "type":"integer",
            "description":"The identifier of the View object that is associated with the entity.",
            "title":"View Object ID"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top