Get all project sets
get
/fscmRestApi/resources/11.13.18.05/jointVentureProjectSets
Request
Query Parameters
-
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 project set that matches the primary key criteria specified.
Finder Variables- projectSetId; integer; The unique identifier of the project set.
- projectSetFinder Finds all project sets that match the specified search criteria.
Finder Variables- description; string; The description; string; of the project set.
- jointVenture; string; The name of the joint venture.
- jointVentureDescription; string; The description; string; of the joint venture.
- language; string; The language; string; associated with the project set.
- languageDescription; string; The description; string; of the language; string; associated with the project set.
- projectSet; string; The name of the project set.
- searchAllText; string; A search value to identify project sets that contain the specified text in any of the string attributes.
- status; string; The status; string; of the project set.
- PrimaryKey Finds the project set that matches the primary key criteria 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:- createdBy; string; The user who created the resource item.
- creationDate; string; The date and time when the resource item was created.
- description; string; The description of the project set.
- jointVenture; string; The name of the joint venture.
- jointVentureDescription; string; The description of the joint venture.
- language; string; The language associated with the project set.
- languageDescription; string; The description of the language associated with the project set.
- lastUpdateDate; string; The date and time when the resource item was last updated.
- lastUpdatedBy; string; The user who last updated the resource item.
- projectSet; string; The name of the project set.
- projectSetId; integer; The unique identifier of the project set.
- status; string; The status of the project set.
-
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:
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.
Root Schema : jointVentureProjectSets
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 : jointVentureProjectSets-item-response
Type:
Show Source
object
-
createdBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the resource item. -
creationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the resource item was created. -
description: string
Title:
Description
Maximum Length:240
The description of the project set. -
filterSetFilters: array
Filter Sets and Filters
Title:
Filter Sets and Filters
The filter sets and filters resource is used to view filter sets and their filters for a project set. -
filterSets: array
Filter Sets
Title:
Filter Sets
The filter sets resource is used to view, create, update, or delete filter sets that are used to group filters within a project set. -
jointVenture: string
Title:
Joint Venture
Maximum Length:30
The name of the joint venture. -
jointVentureDescription: string
Title:
Description
Read Only:true
The description of the joint venture. -
language: string
Title:
Entered Language
Maximum Length:4
The language associated with the project set. -
languageDescription: string
Title:
Language Name
Read Only:true
Maximum Length:255
The description of the language associated with the project set. -
lastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the resource item was last updated. -
lastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the resource item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
projectSet: string
Title:
Project Set
Maximum Length:30
The name of the project set. -
projectSetDFF: array
projectSetDFF
-
projectSetId: integer
(int64)
Title:
Project Set ID
Read Only:true
The unique identifier of the project set. -
status: string
Title:
Status
Maximum Length:80
The status of the project set.
Nested Schema : Filter Sets and Filters
Type:
array
Title:
Filter Sets and Filters
The filter sets and filters resource is used to view filter sets and their filters for a project set.
Show Source
Nested Schema : Filter Sets
Type:
array
Title:
Filter Sets
The filter sets resource is used to view, create, update, or delete filter sets that are used to group filters within a project set.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : jointVentureProjectSets-filterSetFilters-item-response
Type:
Show Source
object
-
attribute: string
Title:
Attribute
Read Only:true
Maximum Length:80
The attribute of the filter. -
description: string
Title:
Description
Read Only:true
Maximum Length:240
The description of the filter set. -
filterCreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the resource item. -
filterCreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the resource item was created. -
filterId: integer
(int64)
Title:
Filter ID
Read Only:true
The unique identifier of the filter. -
filterLastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the resource item was last updated. -
filterLastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the resource item. -
filterSet: string
Title:
Filter Set
Read Only:true
Maximum Length:30
The unique name of the filter set. -
filterSetCreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the resource item. -
filterSetCreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the resource item was created. -
filterSetId: integer
(int64)
Title:
Filter Set ID
Read Only:true
The unique identifier of the filter set. -
filterSetLastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the resource item was last updated. -
filterSetLastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the resource item. -
filterValueCount: integer
Title:
Filter Value Count
Read Only:true
The number of filter values for a Matches Any filter. -
highValue: string
Title:
Value 2
Read Only:true
Maximum Length:240
The second value of the filter. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
lowValue: string
Title:
Value 1
Read Only:true
Maximum Length:240
The first value of the filter. -
operator: string
Title:
Operator
Read Only:true
Maximum Length:80
The operator of the filter.
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.
Nested Schema : jointVentureProjectSets-filterSets-item-response
Type:
Show Source
object
-
createdBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the resource item. -
creationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the resource item was created. -
description: string
Title:
Description
Maximum Length:240
The description of the filter set. -
filters: array
Filters
Title:
Filters
The filters resource is used to view, create, update, or delete filters for a filter set. -
filterSet: string
Title:
Filter Set
Maximum Length:30
The unique name of the filter set. -
filterSetId: integer
(int64)
Title:
Filter Set ID
The unique identifier of the filter set. -
lastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the resource item was last updated. -
lastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the resource item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
projectFilterSetDFF: array
projectFilterSetDFF
Nested Schema : Filters
Type:
array
Title:
Filters
The filters resource is used to view, create, update, or delete filters for a filter set.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : jointVentureProjectSets-filterSets-filters-item-response
Type:
Show Source
object
-
attribute: string
Title:
Attribute
The attribute of the filter. -
createdBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the resource item. -
creationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the resource item was created. -
filterId: integer
(int64)
Title:
Filter ID
The unique identifier of the filter. -
filterValues: array
Filter Values
Title:
Filter Values
The filter values resource is used to view, create, update, or delete filter values. -
highValue: string
Title:
Value 2
Maximum Length:240
The second value of the filter. -
lastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the resource item was last updated. -
lastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the resource item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
lowValue: string
Title:
Value 1
Maximum Length:240
The first value of the filter. -
operator: string
Title:
Operator
The operator of the filter. -
projectFilterDFF: array
projectFilterDFF
Nested Schema : Filter Values
Type:
array
Title:
Filter Values
The filter values resource is used to view, create, update, or delete filter values.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : jointVentureProjectSets-filterSets-filters-filterValues-item-response
Type:
Show Source
object
-
createdBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the resource item. -
creationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the resource item was created. -
filterValueId: integer
(int64)
Title:
Filter Value ID
The unique identifier of the filter value. -
lastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the resource item was last updated. -
lastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the resource item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
projectFilterValueDFF: array
projectFilterValueDFF
-
value: string
Title:
Value
Maximum Length:240
The value to include in a filter's list of values.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : jointVentureProjectSets-filterSets-filters-filterValues-projectFilterValueDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
FilterValueId: integer
(int64)
Title:
Filter Value ID
-
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 : jointVentureProjectSets-filterSets-filters-projectFilterDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
FilterId: integer
(int64)
Title:
Filter ID
-
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 : jointVentureProjectSets-filterSets-projectFilterSetDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
FilterSetId: integer
(int64)
Title:
Filter Set ID
-
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 : jointVentureProjectSets-projectSetDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProjectSetId: integer
(int64)
Title:
Project Set ID
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source