updateApplicationID
put
/ccadmin/v1/applicationIds/{id}
Update Application ID. Updates an Application ID of type application.
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
The ID of the Application ID to update.
Root Schema : updateApplicationID_request
Type:
Show Source
object
-
name:
string
The updated name for the Application ID.
-
type:
string
The Application ID type: application or extension.
Example:
PUT /ccadmin/v1/applicationIds/1036cd9a-844d-4c4a-9dc2-22be5a84ced4
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : updateApplicationID_response
Type:
Show Source
object
-
createdBy(optional):
object createdBy
information about the user who created the application.
-
creationTime(optional):
string
time application was creating in ISO 8601 format.
-
external(optional):
boolean
true if the application ID is external.
-
inUse(optional):
boolean
true if the application ID is currently being used.
-
name(optional):
string
the name of the application.
-
repositoryId(optional):
string
the id of the application ID item.
-
token(optional):
string
The auth token for the application, if of type application.
-
type(optional):
string
the type of application; can be application or extension.
Nested Schema : createdBy
Type:
object
information about the user who created the application.
Show Source
-
firstName(optional):
string
first name of the user.
-
lastName(optional):
string
last name of user.
-
repositoryId(optional):
string
the repository id of the user
Example Response (application/json)
{
"external":false,
"creationTime":"2014-05-08 17:15:43.143",
"createdBy":{
"lastName":"Admin",
"firstName":"Amber",
"repositoryId":"admin",
"id":"admin"
},
"inUse":true,
"name":"another extension name",
"repositoryId":"1036cd9a-844d-4c4a-9dc2-22be5a84ced4",
"id":"1036cd9a-844d-4c4a-9dc2-22be5a84ced4",
"type":"extension"
}
Default Response
The error response
Root Schema : errorModel
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
-
type(optional):
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code