Get all assignments
get
/fscmRestApi/resources/11.13.18.05/dropSchemes/{DropSchemeId}/child/assignments
Request
Path Parameters
-
DropSchemeId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
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 academic entity assignments that match the primary key value specified.
Finder Variables- SettingsAssignmentId; integer; Unique identifier for the academic entity assignment.
- PrimaryKey Finds the academic entity assignments that match the primary key value specified.
-
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:- AssignedEntityCode; string; The user defined identifier of the associated entity.
- AssignedEntityId; integer; The unique identifier of the associated entity.
- AssignedEntityName; string; The name of the associated entity.
- AssignedEntityStatusCode; string; The status code of the entity. This controls the availability of the entity for assignments to settings.
- AssignedEntityStatusMeaning; string; The status of the entity.
- AssignedEntitySubTypeCode; string; The entity subtype code of the associated entity.
- AssignedEntitySubTypeMeaning; string; The entity subtype of the associated entity.
- AssignedEntityTypeCode; string; The type code of the associated entity. A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE.
- AssignedEntityTypeMeaning; string; The entity type of the associated entity.
- AssignedSettingsObjectId; integer; The unique identifier of the associated setting.
- AssignedSettingsTypeCode; string; The type code of the associated setting.
- AssignmentEndDate; string; The end or expiration date of the entity assignment.
- AssignmentMethodMeaning; string; The assignment method type meaning used to indicate how the settings are assigned to the entity. A list of accepted values is defined in the lookup type ORA_HEY_SETTINGS_ASSIGN_METHOD.
- AssignmentMethodTypeCode; string; The assignment method type code indicating how the settings are assigned to the entity. A list of accepted values is defined in the lookup type ORA_HEY_SETTINGS_ASSIGN_METHOD.
- AssignmentStartDate; string; The start date of the entity assignment.
- CreatedBy; string; The user who created the row.
- CreationDate; string; The date the row was created.
- LastUpdateDate; string; The date the row was last updated.
- LastUpdatedBy; string; The user who last updated the row.
- RelatedEntityCode; string; The user defined identifier of the related entity.
- RelatedEntityId; integer; The unique identifier of the related entity.
- RelatedEntityName; string; The name of the related entity.
- RelatedEntityTypeCode; string; The entity type code of the related entity. A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE.
- RelatedEntityTypeMeaning; string; The entity type of the related entity.
- SettingsAssignmentId; integer; The unique identifier for the setup association record.
-
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 : dropSchemes-assignments
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 : dropSchemes-assignments-item-response
Type:
Show Source
object
-
AssignedEntityCode: string
Title:
Entity Code
Read Only:true
Maximum Length:100
The user defined identifier of the associated entity. -
AssignedEntityId: integer
(int64)
Title:
Entity ID
The unique identifier of the associated entity. -
AssignedEntityName: string
Title:
Entity Name
Read Only:true
Maximum Length:100
The name of the associated entity. -
AssignedEntityStatusCode: string
Title:
Entity Status Code
Read Only:true
Maximum Length:30
The status code of the entity. This controls the availability of the entity for assignments to settings. -
AssignedEntityStatusMeaning: string
Title:
Status
Read Only:true
Maximum Length:80
The status of the entity. -
AssignedEntitySubTypeCode: string
Title:
Entity Subtype Code
Read Only:true
Maximum Length:30
The entity subtype code of the associated entity. -
AssignedEntitySubTypeMeaning: string
Title:
Entity Subtype
Read Only:true
Maximum Length:80
The entity subtype of the associated entity. -
AssignedEntityTypeCode: string
Title:
Entity Type Code
Maximum Length:30
The type code of the associated entity. A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE. -
AssignedEntityTypeMeaning: string
Title:
Entity Type
Read Only:true
Maximum Length:80
The entity type of the associated entity. -
AssignedSettingsObjectId: integer
(int64)
Title:
Settings Object ID
The unique identifier of the associated setting. -
AssignedSettingsTypeCode: string
Title:
Settings Type Code
Read Only:true
Maximum Length:30
Default Value:ORA_HER_DROP_SCHEME
The type code of the associated setting. -
AssignmentEndDate: string
(date)
Title:
Assignment End Date
The end or expiration date of the entity assignment. -
AssignmentMethodMeaning: string
Title:
Assignment Method
Read Only:true
Maximum Length:80
The assignment method type meaning used to indicate how the settings are assigned to the entity. A list of accepted values is defined in the lookup type ORA_HEY_SETTINGS_ASSIGN_METHOD. -
AssignmentMethodTypeCode: string
Title:
Assignment Method Code
Maximum Length:30
Default Value:ORA_DIRECT
The assignment method type code indicating how the settings are assigned to the entity. A list of accepted values is defined in the lookup type ORA_HEY_SETTINGS_ASSIGN_METHOD. -
AssignmentStartDate: string
(date)
Title:
Assignment Start Date
The start date of the entity assignment. -
associatedAssignments: array
Drop Scheme Settings Associated Assignments
Title:
Drop Scheme Settings Associated Assignments
The associated assignments resource is used to list the academic entity associated object assigned to the drop scheme settings. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the row. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date the row was created. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date the row was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RelatedEntityCode: string
Title:
Related Entity Code
Read Only:true
Maximum Length:100
The user defined identifier of the related entity. -
RelatedEntityId: integer
(int64)
Title:
Related Entity ID
The unique identifier of the related entity. -
RelatedEntityName: string
Title:
Related Entity Name
Read Only:true
Maximum Length:100
The name of the related entity. -
RelatedEntityTypeCode: string
Title:
Related Entity Type Code
Maximum Length:30
The entity type code of the related entity. A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE. -
RelatedEntityTypeMeaning: string
Title:
Related Entity Type
Read Only:true
Maximum Length:80
The entity type of the related entity. -
SettingsAssignmentId: integer
(int64)
Title:
Settings Assignment ID
Read Only:true
The unique identifier for the setup association record.
Nested Schema : Drop Scheme Settings Associated Assignments
Type:
array
Title:
Drop Scheme Settings Associated Assignments
The associated assignments resource is used to list the academic entity associated object assigned to the drop scheme settings.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : dropSchemes-assignments-associatedAssignments-item-response
Type:
Show Source
object
-
AssociatedAssignmentId: integer
(int64)
Title:
Associated Assignment ID
Read Only:true
The unique identifier for the settings associated assignment record. -
AssociatedObjectCode: string
Title:
Academic Level Code
Read Only:true
Maximum Length:100
The unique code of the object. It can be an academic level code. -
AssociatedObjectId: integer
(int64)
Title:
Associated Object ID
The unique identifier of the object. It can be an academic level ID. -
AssociatedObjectName: string
Title:
Academic Level Name
Read Only:true
Maximum Length:100
The name of the object. It can be an academic level name. -
AssociatedObjectTypeCode: string
Title:
Associated Object Type Code
Maximum Length:30
Default Value:ORA_HER_ACADEMIC_LEVEL
The type code of the associated object. A list of accepted values is defined in the lookup type ORA_HEY_SUB_OBJECT_TYPE. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
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.