- Home
- Resources
- ProfileResource
The following resources are applicable:
GET /profile/root
Retrieves the root nodes in Product Hierarchy.
This service does not take any input parameters from the profile UI.
It returns the top nodes in Product Hierarchy.
Response Codes
| code |
condition |
| 200 |
Returned if request was successfully executed. |
| 500 |
Returned if request was NOT successfully executed. |
Response Body
| media type |
data type |
| application/vnd.ptc.sc+json |
object
(JSON) |
GET /profile/privileges
Retrieves the privileges for the site context.
This service does not take any input parameters from the profile UI.
Response Codes
| code |
condition |
| 200 |
Returned if request was successfully executed. |
| 500 |
Returned if request was NOT successfully executed. |
Response Body
| media type |
data type |
| application/vnd.ptc.sc+json |
object
(JSON) |
GET /profile/{profileId}/root
Retrieves the root nodes in Product Hierarchy.
This service takes input parameter as profile Id from the profile UI.
It returns the top nodes in Product Hierarchy with selections based on profile.
Request Parameters
| name |
type |
description |
default |
| profileId |
path |
Unique profile id. |
n/a |
Response Codes
| code |
condition |
| 200 |
Returned if request was successfully executed. |
| 500 |
Returned if request was NOT successfully executed. |
Response Body
| media type |
data type |
| application/vnd.ptc.sc+json |
object
(JSON) |
GET /profile/user/{userId}
Merges the associated profiles for the given user.
It merges the PHNode, Information Type and privileges of the profiles.
Request Parameters
| name |
type |
description |
default |
| userId |
path |
to merge the associated profiles |
n/a |
Response Codes
| code |
condition |
| 200 |
Returned if request was successfully executed. |
| 500 |
Returned if request was NOT successfully executed. |
Response Body
| media type |
data type |
| application/vnd.ptc.sc+json |
object
(JSON) |
GET /profile/userprofiles/{userId}
Returns the associated profiles for the given user.
Request Parameters
| name |
type |
description |
default |
| userId |
path |
to merge the associated profiles |
n/a |
Response Codes
| code |
condition |
| 200 |
Returned if request was successfully executed. |
| 500 |
Returned if request was NOT successfully executed. |
Response Body
| media type |
data type |
| application/vnd.ptc.sc+json |
object
(JSON) |
GET /profile/{profileId}/member/{uid}
Check if user is a member of given profile.
Request Parameters
| name |
type |
description |
default |
| profileId |
path |
SCID of a profile. |
n/a |
| uid |
path |
Unique user identifier. |
n/a |
Response Codes
| code |
condition |
| 200 |
Returned if system is successfully retrieved.. |
| 500 |
Returned if system is NOT successfully retrieved. |
Response Body
| media type |
data type |
| application/vnd.ptc.sc+json |
object
(JSON) |
GET /profile/infoTypes
Retrieves the Information Attributes for create UI.
Response Codes
| code |
condition |
| 200 |
Returned if request was successfully executed. |
| 500 |
Returned if request was NOT successfully executed. |
Response Body
| media type |
data type |
| application/vnd.ptc.sc+json |
object
(JSON) |
GET /profile/{profileId}/{productId}/children
Retrieves the children nodes in Product Hierarchy.
This service takes input as Profile id and Product Id from the profile UI.
It returns the products that should be displayed as the children under
the given Product along with the selections based on profile.
Request Parameters
| name |
type |
description |
default |
| productId |
path |
Unique product id. |
n/a |
| profileId |
path |
Unique profile id. |
n/a |
| $expand |
query |
The OData expand clause used to expand related objects and
collections.
To expand the children collection when requesting the product node
use: $expand=children
To expand the primary topic root object when requesting the product
node use: $expand=primaryTopicRoot
To expand the product instances collection when requesting the product node
use: $expand=instances
To expand the effectivity filter collection when requesting the product node
use: $expand=effectivityFilters |
n/a |
| $filter |
query |
-- Reserved for future use. -- |
n/a |
| $orderby |
query |
The OData order by. |
n/a |
| $skip |
query |
The number of items to skip for the start of this page. |
n/a |
| $top |
query |
The number of objects to return in this page. |
n/a |
| effectivity |
query |
The OData filter including the effectivity filter to
apply. |
n/a |
Response Codes
| code |
condition |
| 200 |
Returned if request was successfully executed. |
| 500 |
Returned if request was NOT successfully executed. |
Response Body
| media type |
data type |
| application/vnd.ptc.sc+json |
object
(JSON) |
GET /profile/{productId}/children
Retrieves the children nodes in Product Hierarchy.
This service takes input as Product Id from the profile UI.
It returns the products that should be displayed as the children under the given Product
Request Parameters
| name |
type |
description |
default |
| productId |
path |
Unique product id. |
n/a |
| $expand |
query |
The OData expand clause used to expand related objects and
collections.
To expand the children collection when requesting the product node
use: $expand=children
To expand the primary topic root object when requesting the product
node use: $expand=primaryTopicRoot
To expand the product instances collection when requesting the product node
use: $expand=instances
To expand the effectivity filter collection when requesting the product node
use: $expand=effectivityFilters |
n/a |
| $filter |
query |
-- Reserved for future use. -- |
n/a |
| $orderby |
query |
The OData order by. |
n/a |
| $skip |
query |
The number of items to skip for the start of this page. |
n/a |
| $top |
query |
The number of objects to return in this page. |
n/a |
| effectivity |
query |
The OData filter including the effectivity filter to
apply. |
n/a |
Response Codes
| code |
condition |
| 200 |
Returned if request was successfully executed. |
| 500 |
Returned if request was NOT successfully executed. |
Response Body
| media type |
data type |
| application/vnd.ptc.sc+json |
object
(JSON) |
POST /profile
Submits a user's profile to the system and persists the profile.
This service takes an SCList that has one SCItem containing all of
the form input parameters from the profile UI as attributes. It uses
these input parameters to save the profile.
Request Body
| media type |
data type |
description |
| application/vnd.ptc.sc+json |
SCList
(JSON) |
The SCList containing the profile item to be saved.first item in list will be saved |
Response Codes
| code |
condition |
| 200 |
Returned if profile was successfully submitted. |
| 500 |
Returned if profile was NOT successfully submitted. |
Response Body
| media type |
data type |
| application/vnd.ptc.sc+json |
SCList
(JSON) |
DELETE /profile/{profileId}
Deletes a user's profile.
This service takes an Id input parameter from the profile UI as attributes.
Request Parameters
| name |
type |
description |
default |
| profileId |
path |
The String containing the profile id. |
n/a |
Response Codes
| code |
condition |
| 200 |
Returned if profile was successfully deleted. |
| 500 |
Returned if profile was NOT successfully deleted. |
Response Body
| media type |
data type |
| application/vnd.ptc.sc+json |
object
(JSON) |
GET /profile
Get all the profiles for a user.
This service takes filtering info from the profile UI as attributes.
Request Parameters
| name |
type |
description |
default |
| $expand |
query |
the OData expand clause used to expand attribute objects
and collections. To expand the items collection when
requesting the profile use: $expand=items |
n/a |
| $filter |
query |
-- Reserved for future use. -- |
n/a |
| $orderby |
query |
the ordering of profile items when expanding items |
n/a |
| $skip |
query |
the number of profile items to skip for paging when expanding items |
n/a |
| $top |
query |
the number of profile items to return in a page when expanding items |
n/a |
Response Codes
| code |
condition |
| 200 |
Returned if profiles were successfully retrieved.. |
| 500 |
Returned if profiles were NOT successfully retrieved. |
Response Body
| media type |
data type |
| application/vnd.ptc.sc+json |
SCList
(JSON) |
GET /profile/{profileId}/members
Get users for a given profile Id.
This service takes filtering info from the profile UI as attributes.
Request Parameters
| name |
type |
description |
default |
| profileId |
path |
Unique profile id. |
n/a |
| $expand |
query |
the OData expand clause used to expand attribute objects
and collections. To expand the items collection when
requesting the user use: $expand=items |
n/a |
| $filter |
query |
-- Reserved for future use. -- |
n/a |
| $orderby |
query |
the ordering of user items when expanding items |
n/a |
| $skip |
query |
the number of user items to skip for paging when expanding items |
n/a |
| $top |
query |
the number of user items to return in a page when expanding items |
n/a |
Response Codes
| code |
condition |
| 200 |
Returned if profiles were successfully retrieved.. |
| 500 |
Returned if profiles were NOT successfully retrieved. |
Response Body
| media type |
data type |
| application/vnd.ptc.sc+json |
SCList
(JSON) |
GET /profile/{profileId}
Get the profiles for a user.
This service takes filtering info from the profile UI as attributes.
Request Parameters
| name |
type |
description |
default |
| profileId |
path |
Id of profile which is to be returned. |
n/a |
Response Codes
| code |
condition |
| 200 |
Returned if profile is successfully retrieved.. |
| 500 |
Returned if profiles is NOT successfully retrieved. |
Response Body
| media type |
data type |
| application/vnd.ptc.sc+json |
object
(JSON) |
POST /profile/{profileId}
updates a user's profile to the system.
This service takes an SCList that has one SCItem containing all of
the form input parameters from the profile UI as attributes. It uses
these input parameters to update the profile.
Request Body
| media type |
data type |
description |
| application/vnd.ptc.sc+json |
SCList
(JSON) |
The SCList containing the profile item to be saved. |
Response Codes
| code |
condition |
| 200 |
Returned if profile was successfully updated. |
| 500 |
Returned if profile was NOT successfully updated. |
Response Body
| media type |
data type |
| application/vnd.ptc.sc+json |
SCList
(JSON) |
POST /profile/expiration/{profileId}
updates a profile's exipration date to the system.
This service takes an SCList that has one SCItem containing all of
the form input parameters from the profile UI as attributes. It uses
these input parameters to update the profile.
Request Parameters
| name |
type |
description |
default |
| profileId |
path |
Unique profile id. |
n/a |
Request Body
| media type |
data type |
description |
| application/vnd.ptc.sc+json |
SCList
(JSON) |
The SCList containing the profile item to be saved. |
Response Codes
| code |
condition |
| 200 |
Returned if profile was successfully updated. |
| 500 |
Returned if profile was NOT successfully updated. |
Response Body
| media type |
data type |
| application/vnd.ptc.sc+json |
SCList
(JSON) |
GET /profile/ie/rc
Retrieves the IE Restriction Code.
Response Codes
| code |
condition |
| 200 |
Returned if request was successfully executed. |
| 500 |
Returned if request was NOT successfully executed. |
Response Body
| media type |
data type |
| application/vnd.ptc.sc+json |
object
(JSON) |
GET /profile/ph/rc
Retrieves the PH Restriction Code.
Response Codes
| code |
condition |
| 200 |
Returned if request was successfully executed. |
| 500 |
Returned if request was NOT successfully executed. |
Response Body
| media type |
data type |
| application/vnd.ptc.sc+json |
object
(JSON) |
GET /profile/optionAndChoices
Retrieves available options and their corresponding choices.
Response Codes
| code |
condition |
| 200 |
Returned if request was successfully executed. |
| 500 |
Returned if request was NOT successfully executed. |
Response Body
| media type |
data type |
| application/vnd.ptc.sc+json |
object
(JSON) |
GET /profile/objectDetails
End point to fetch any SC object update details
Response Body
| media type |
data type |
| application/vnd.ptc.sc+json |
object
(JSON) |
GET /profile/objectDetails/{profileId}
Method to fetch specific profile object update information.
Request Parameters
| name |
type |
description |
default |
| profileId |
path |
SCId of the profile for which update information needs to
retrieved. |
n/a |
Response Body
| media type |
data type |
| application/vnd.ptc.sc+json |
object
(JSON) |
PUT /profile/updateObjDetails
Method to update 'messageSeenStatus' of SCObjectUpdateDetails records.
Request Body
| media type |
data type |
description |
| application/vnd.ptc.sc+json |
SCItem
(JSON) |
SCItem containing object information for which this action ot
be performed. |
Response Body
| media type |
data type |
| application/vnd.ptc.sc+json |
SCItem
(JSON) |
GET /profile/count/{customerId}
Retrieves the number of unique users .
Request Parameters
| name |
type |
description |
default |
| customerId |
path |
|
n/a |
| fromDate |
query |
|
n/a |
| profileType |
query |
|
n/a |
| toDate |
query |
|
n/a |
Response Codes
| code |
condition |
| 200 |
Returned if request was successfully executed. |
| 500 |
Returned if request was NOT successfully executed. |
Response Body
| media type |
data type |
| application/vnd.ptc.sc+json |
object
(JSON) |
GET /profile/profileTypes
Response Body
| media type |
data type |
| application/vnd.ptc.sc+json |
object
(JSON) |