- Home
- Resources
- DisconnectedSystemResource
The Attribute resource provides flexibility to add/delete attributes to a
given type
Data Model Objects
The following resources are applicable:
GET /disconnectedSystem/{systemId}
Get the system.
Request Parameters
| name |
type |
description |
default |
| systemId |
path |
String containing disconnected system. |
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 /disconnectedSystem
Gets All Disconnected System.
Request Parameters
| name |
type |
description |
default |
| $expand |
query |
The OData expand clause used to expand related objects and
collections. |
n/a |
| $filter |
query |
String representing filter -- Reserved for future use. -- |
n/a |
| $orderby |
query |
String representing the ordering of user items when expanding items |
n/a |
| $skip |
query |
String representing the number of user items to skip for paging when expanding
items |
n/a |
| $top |
query |
String representing the number of user items to return in a page when expanding
items |
n/a |
Response Codes
| code |
condition |
| 404 |
when unable to find the user data |
Response Body
| media type |
data type |
| application/vnd.ptc.sc+json |
SCList
(JSON) |
POST /disconnectedSystem
Adds a given disconnected system to Service Centre.
Request Body
| media type |
data type |
description |
| application/vnd.ptc.sc+json |
SCItem
(JSON) |
containing the system that needs to be created. |
Response Body
| media type |
data type |
| application/vnd.ptc.sc+json |
SCItem
(JSON) |
PUT /disconnectedSystem/{systemId}
Updates a given system.
Request Parameters
| name |
type |
description |
default |
| systemId |
path |
String representing system Id |
n/a |
Request Body
| media type |
data type |
description |
| application/vnd.ptc.sc+json |
SCItem
(JSON) |
containing the system that needs to be updated with modified
values |
Response Body
| media type |
data type |
| application/vnd.ptc.sc+json |
SCItem
(JSON) |
DELETE /disconnectedSystem/{systemId}
Deletes a specific Disconnected System.
This service takes an Id input parameter from the Disconnected System UI as attribute.
Request Parameters
| name |
type |
description |
default |
| systemId |
path |
The String containing the system's id. |
n/a |
Response Codes
| code |
condition |
| 200 |
Returned if system was successfully deleted. |
| 500 |
Returned if system was NOT successfully deleted. |
Response Body
| media type |
data type |
| application/vnd.ptc.sc+json |
object
(JSON) |
PUT /disconnectedSystem/{systemId}/export
Starts the export process for a disconnected system configuration.
Request Parameters
| name |
type |
description |
default |
| systemId |
path |
SCId of disconnected system. |
n/a |
Response Body
| media type |
data type |
| application/vnd.ptc.sc+json |
object
(JSON) |
POST /disconnectedSystem/import
Imports the disconnected system configuration.
Request Body
| media type |
data type |
| multipart/form-data |
(custom)
|
Response Body
| media type |
data type |
| application/vnd.ptc.sc+json |
object
(JSON) |
PUT /disconnectedSystem/changePassword
Change password for logged in user on disconnected system
Request Body
| media type |
data type |
description |
| application/vnd.ptc.sc+json |
SCItem
(JSON) |
scitem containing new password to change. Any other attributes will be ignored |
Response Codes
| code |
condition |
| 204 |
Returned if password was successfully changed. |
| 403 |
Returned when system type is not disconnected |
| 406 |
Returned when new supplied password doesn't pass validation |
Response Body
| media type |
data type |
| application/vnd.ptc.sc+json |
SCItem
(JSON) |
GET /disconnectedSystem/checkCurrentUserPasswordChanged
Check if it is first time login into disconnected system for current user.
Response Codes
| code |
condition |
| 403 |
Returned when system type is not disconnected |
Response Body
| media type |
data type |
| application/vnd.ptc.sc+json |
object
(JSON) |
POST /disconnectedSystem/checkUserPasswordChanged
Check if it is first time login into disconnected system for current user.
Request Body
| media type |
data type |
description |
| application/vnd.ptc.sc+json |
SCItem
(JSON) |
SCItem containing user ID |
Response Codes
| code |
condition |
| 403 |
Returned when system type is not disconnected |
Response Body
| media type |
data type |
| application/vnd.ptc.sc+json |
SCItem
(JSON) |
PUT /disconnectedSystem/setCurrentUserPasswordChanged
Set information about current user password changed.
Response Body
| media type |
data type |
| application/vnd.ptc.sc+json |
object
(JSON) |
PUT /disconnectedSystem/setUserPasswordChanged
Set information about user password changed.
Request Body
| media type |
data type |
description |
| application/vnd.ptc.sc+json |
SCItem
(JSON) |
scitem containing user id. Any other attributes will be ignored |
Response Codes
| code |
condition |
| 400 |
if there is no userID inside SCItem |
Response Body
| media type |
data type |
| application/vnd.ptc.sc+json |
SCItem
(JSON) |
GET /disconnectedSystem/isAdmin
Check if current user is administrator.
Response Codes
| code |
condition |
| 403 |
Returned when system type is not disconnected |
Response Body
| media type |
data type |
| application/vnd.ptc.sc+json |
object
(JSON) |
GET /disconnectedSystem/hasSharedSegment
Check if there is loaded Shared segment into system
Response Body
| media type |
data type |
| application/vnd.ptc.sc+json |
object
(JSON) |
POST /disconnectedSystem/license
Creates License Configuration for a non-service group user.
Request Body
| media type |
data type |
description |
| application/vnd.ptc.sc+json |
SCItem
(JSON) |
SCItem containing relevant information that is required to created License Configuration. |
Response Codes
| code |
condition |
| 200 |
Returned if license configuration is successfully created for a non-service group user. |
| 500 |
Returned if anything goes wrong while creating license configuration |
Response Body
| media type |
data type |
| application/vnd.ptc.sc+json |
SCItem
(JSON) |
GET /disconnectedSystem/{userId}/license
Get license configuration details of a given non-service group user.
Request Parameters
| name |
type |
description |
default |
| userId |
path |
Non-service group user id. |
n/a |
Response Codes
| code |
condition |
| 200 |
Returned if license configuration details of a given non-service group user are fetched successfully. |
| 500 |
Returned if license configuration details of a given non-service group user are not fetched successfully. |
Response Body
| media type |
data type |
| application/vnd.ptc.sc+json |
SCItem
(JSON) |
DELETE /disconnectedSystem/{userId}/license
Deleted license configuration details associated with a given non-service
group user.
Request Parameters
| name |
type |
description |
default |
| userId |
path |
Non-service group id. |
n/a |
Response Codes
| code |
condition |
| 200 |
Returned if license configuration details associated with a given non-service is deleted successfully. |
| 500 |
Returned if license configuration details associated with a given non-service is not deleted successfully. |
Response Body
| media type |
data type |
| application/vnd.ptc.sc+json |
SCItem
(JSON) |
PUT /disconnectedSystem/{disconnectedId}/license
Updates License configuration details associated with a non-service group
user.
Request Parameters
| name |
type |
description |
default |
| disconnectedId |
path |
|
n/a |
Request Body
| media type |
data type |
description |
| application/vnd.ptc.sc+json |
SCItem
(JSON) |
SCitem containing updated license configuration details. |
Response Codes
| code |
condition |
| 200 |
Returned if License configuration details associated with a non-service group are updated successfully. |
| 500 |
Returned if License configuration details associated with a non-service group are not updated successfully. |
Response Body
| media type |
data type |
| application/vnd.ptc.sc+json |
SCItem
(JSON) |
PUT /disconnectedSystem/{userId}/license/revoke
Revokes non-service group user license.
Request Parameters
| name |
type |
description |
default |
| userId |
path |
Non-service group user id. |
n/a |
Response Codes
| code |
condition |
| 200 |
Returned if non-service group user license is revoked successfully. |
| 500 |
Returned if non-service group user license revoke fails. |
Response Body
| media type |
data type |
| application/vnd.ptc.sc+json |
SCItem
(JSON) |
PUT /disconnectedSystem/authenticateUser
Request Body
| media type |
data type |
| application/vnd.ptc.sc+json |
SCItem
(JSON) |
Response Body
| media type |
data type |
| application/vnd.ptc.sc+json |
object
(JSON) |