NOT FOR PUBLIC DISTRIBUTION: 2020-09-23
Update a profile template record
put
/spms/v1/profileConfigurations
This is to update a profile template record
Request
Supported Media Types
- application/json
Profile templates
Root Schema : ProfileConfigurationsWithId
Type:
object
Profile templates
Show Source
-
enabled(optional):
boolean
Indicates whether this field is enabled or notExample:
true
-
id(optional):
integer
Minimum Value:
1
This is the profile template primary keyExample:1
-
mandatory(optional):
boolean
Indicates whether this column is mandatoryExample:
true
-
profileConfigurationId(optional):
integer
Minimum Value:
1
Indicates which category of profile template it belongs toExample:1
-
profileId(optional):
integer
Minimum Value:
1
This is the id of a profile typeExample:1
Response
Supported Media Types
- application/json
200 Response
Profile template updated successfully
Root Schema : ProfileConfigurations
Type:
object
Profile Templates
Show Source
-
enabled(optional):
boolean
Indicates whether this field is enabled or notExample:
true
-
mandatory(optional):
boolean
Indicates whether this column is mandatoryExample:
true
-
profileConfigurationId(optional):
integer
Minimum Value:
1
Indicates which category of profile template this profile template belongs toExample:1
-
profileId(optional):
integer
Minimum Value:
1
This is the id of a profile typeExample:1
400 Response
The supplied parameter(s) is not valid
Root Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
-
detail(optional):
string
Example:
There are validation errors for the object......
-
title(optional):
string
Example:
validation fails for row with key={123}
-
type(optional):
string
Example:
HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
401 Response
You are not authorized to use this API
Root Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
-
detail(optional):
string
Example:
There are validation errors for the object......
-
title(optional):
string
Example:
validation fails for row with key={123}
-
type(optional):
string
Example:
HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
403 Response
You are forbidden to use this API
Root Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
-
detail(optional):
string
Example:
There are validation errors for the object......
-
title(optional):
string
Example:
validation fails for row with key={123}
-
type(optional):
string
Example:
HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
404 Response
The profile template does not exist
Root Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
-
detail(optional):
string
Example:
There are validation errors for the object......
-
title(optional):
string
Example:
validation fails for row with key={123}
-
type(optional):
string
Example:
HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
405 Response
This method is not available
Root Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
-
detail(optional):
string
Example:
There are validation errors for the object......
-
title(optional):
string
Example:
validation fails for row with key={123}
-
type(optional):
string
Example:
HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
406 Response
The Wizard Id or profile Id supplied does not exist
Root Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
-
detail(optional):
string
Example:
There are validation errors for the object......
-
title(optional):
string
Example:
validation fails for row with key={123}
-
type(optional):
string
Example:
HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
409 Response
You are trying to update to an existing profile template
Root Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
-
detail(optional):
string
Example:
There are validation errors for the object......
-
title(optional):
string
Example:
validation fails for row with key={123}
-
type(optional):
string
Example:
HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
415 Response
The media supplied is not supported
Root Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
-
detail(optional):
string
Example:
There are validation errors for the object......
-
title(optional):
string
Example:
validation fails for row with key={123}
-
type(optional):
string
Example:
HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
500 Response
Error occurred while processing this request
Root Schema : Error Response
Type:
object
Title:
Error Response
Error Response returned when encountered error
Show Source
-
detail(optional):
string
Example:
There are validation errors for the object......
-
title(optional):
string
Example:
validation fails for row with key={123}
-
type(optional):
string
Example:
HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1
502 Response
Bad Gateway
503 Response
Service not available