Create a project set
post
/fscmRestApi/resources/11.13.18.05/jointVentureProjectSets
Request
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
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. -
language: string
Title:
Entered Language
Maximum Length:4
The language associated with the project set. -
projectSet(required): string
Title:
Project Set
Maximum Length:30
The name of the project set. -
projectSetDFF: array
projectSetDFF
-
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 : jointVentureProjectSets-filterSets-item-post-request
Type:
Show Source
object
-
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. -
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 : jointVentureProjectSets-filterSets-filters-item-post-request
Type:
Show Source
object
-
attribute: string
Title:
Attribute
The attribute of the filter. -
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. -
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 : jointVentureProjectSets-filterSets-filters-filterValues-item-post-request
Type:
Show Source
object
-
filterValueId: integer
(int64)
Title:
Filter Value ID
The unique identifier of the filter value. -
projectFilterValueDFF: array
projectFilterValueDFF
-
value: string
Title:
Value
Maximum Length:240
The value to include in a filter's list of values.
Nested Schema : jointVentureProjectSets-filterSets-filters-filterValues-projectFilterValueDFF-item-post-request
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
Nested Schema : schema
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
Nested Schema : jointVentureProjectSets-filterSets-projectFilterSetDFF-item-post-request
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
Nested Schema : schema
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
ProjectSetId: integer
(int64)
Title:
Project Set ID
Response
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-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
Links
- filterSetFilters
-
Operation: /fscmRestApi/resources/11.13.18.05/jointVentureProjectSets/{projectSetId}/child/filterSetFiltersParameters:
- projectSetId:
$request.path.projectSetId
The filter sets and filters resource is used to view filter sets and their filters for a project set. - projectSetId:
- filterSets
-
Operation: /fscmRestApi/resources/11.13.18.05/jointVentureProjectSets/{projectSetId}/child/filterSetsParameters:
- projectSetId:
$request.path.projectSetId
The filter sets resource is used to view, create, update, or delete filter sets that are used to group filters within a project set. - projectSetId:
- projectSetDFF
-
Operation: /fscmRestApi/resources/11.13.18.05/jointVentureProjectSets/{projectSetId}/child/projectSetDFFParameters:
- projectSetId:
$request.path.projectSetId
- projectSetId: