Jump to

• Request
• Response

getApplicationIDs

get

/ccadmin/v1/applicationIds

Get Application IDs. Returns Application IDs of the specified type or all IDs if type is not specified. It also returns Application IDs based on the SCIM query options.

Request

Supported Media Types

• application/json

Query Parameters

• limit: string
  The maximum number of applications to be returned from this request.
• offset: string
  The starting offset/index to be returned from this request.
• q: string
  Query string that filters the applications list to be returned from this request using SCIM filtering syntax.
• sort: string
  The sort order of the list to be returned from this request.
• type(required): string
  The type of Application to retrieve.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : getApplicationIDs_response

Type: object

Show Source

• items: array items
  the list of Application IDs.

{
    "properties":{
        "items":{
            "description":"the list of Application IDs.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "external":{
                        "description":"true if the application ID is external.",
                        "type":"boolean"
                    },
                    "creationTime":{
                        "description":"time application was creating in ISO 8601 format.",
                        "type":"string"
                    },
                    "createdBy":{
                        "description":"information about the user who created the application.",
                        "type":"object",
                        "properties":{
                            "lastName":{
                                "description":"last name of user.",
                                "type":"string"
                            },
                            "firstName":{
                                "description":"first name of the user.",
                                "type":"string"
                            },
                            "repositoryId":{
                                "description":"the repository id of the user",
                                "type":"string"
                            }
                        }
                    },
                    "repositoryId":{
                        "description":"the id of the application ID item.",
                        "type":"string"
                    },
                    "name":{
                        "description":"the name of the application.",
                        "type":"string"
                    },
                    "inUse":{
                        "description":"true if the application ID is currently being used.",
                        "type":"boolean"
                    },
                    "type":{
                        "description":"the type of application; can be application or extension.",
                        "type":"string"
                    },
                    "token":{
                        "description":"The auth token for the application, if of type application.",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: array

the list of Application IDs.

Show Source

• Array of: object items

{
    "description":"the list of Application IDs.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "external":{
                "description":"true if the application ID is external.",
                "type":"boolean"
            },
            "creationTime":{
                "description":"time application was creating in ISO 8601 format.",
                "type":"string"
            },
            "createdBy":{
                "description":"information about the user who created the application.",
                "type":"object",
                "properties":{
                    "lastName":{
                        "description":"last name of user.",
                        "type":"string"
                    },
                    "firstName":{
                        "description":"first name of the user.",
                        "type":"string"
                    },
                    "repositoryId":{
                        "description":"the repository id of the user",
                        "type":"string"
                    }
                }
            },
            "repositoryId":{
                "description":"the id of the application ID item.",
                "type":"string"
            },
            "name":{
                "description":"the name of the application.",
                "type":"string"
            },
            "inUse":{
                "description":"true if the application ID is currently being used.",
                "type":"boolean"
            },
            "type":{
                "description":"the type of application; can be application or extension.",
                "type":"string"
            },
            "token":{
                "description":"The auth token for the application, if of type application.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• createdBy: object createdBy
  information about the user who created the application.
• creationTime: string
  time application was creating in ISO 8601 format.
• external: boolean
  true if the application ID is external.
• inUse: boolean
  true if the application ID is currently being used.
• name: string
  the name of the application.
• repositoryId: string
  the id of the application ID item.
• token: string
  The auth token for the application, if of type application.
• type: string
  the type of application; can be application or extension.

{
    "type":"object",
    "properties":{
        "external":{
            "description":"true if the application ID is external.",
            "type":"boolean"
        },
        "creationTime":{
            "description":"time application was creating in ISO 8601 format.",
            "type":"string"
        },
        "createdBy":{
            "description":"information about the user who created the application.",
            "type":"object",
            "properties":{
                "lastName":{
                    "description":"last name of user.",
                    "type":"string"
                },
                "firstName":{
                    "description":"first name of the user.",
                    "type":"string"
                },
                "repositoryId":{
                    "description":"the repository id of the user",
                    "type":"string"
                }
            }
        },
        "repositoryId":{
            "description":"the id of the application ID item.",
            "type":"string"
        },
        "name":{
            "description":"the name of the application.",
            "type":"string"
        },
        "inUse":{
            "description":"true if the application ID is currently being used.",
            "type":"boolean"
        },
        "type":{
            "description":"the type of application; can be application or extension.",
            "type":"string"
        },
        "token":{
            "description":"The auth token for the application, if of type application.",
            "type":"string"
        }
    }
}

Nested Schema : createdBy

Type: object

information about the user who created the application.

Show Source

• firstName: string
  first name of the user.
• lastName: string
  last name of user.
• repositoryId: string
  the repository id of the user

{
    "description":"information about the user who created the application.",
    "type":"object",
    "properties":{
        "lastName":{
            "description":"last name of user.",
            "type":"string"
        },
        "firstName":{
            "description":"first name of the user.",
            "type":"string"
        },
        "repositoryId":{
            "description":"the repository id of the user",
            "type":"string"
        }
    }
}

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"
    },
    {
        "creationTime":"2014-05-08 17:15:26.328",
        "createdBy":{
            "lastName":"Admin",
            "firstName":"Amber",
            "repositoryId":"admin",
            "id":"admin"
        },
        "name":"new extension name",
        "repositoryId":"d5be81d5-79fb-44af-8281-b5afa81d8fef",
        "id":"d5be81d5-79fb-44af-8281-b5afa81d8fef",
        "type":"extension"
    }
]

Default Response

The error response

Body ()

Root Schema : errorModel

Type: object

Show Source

• devMessage: string
  An optional non-localized message containing technical information for developers
• errorCode: string
  The numerical code identifying the error
• errors: array errors
  An optional list of errors if multiple errors were encountered
• message: string
  The localized message describing the error
• moreInfo: string
  An optional non-localized message with more information
• o:errorPath: string
  An optional machine readable description of where the error occurred
• status: string
  The HTTP status code
• type: string
  The URI to the HTTP state code definition

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• devMessage: string
  An optional non-localized message containing technical information for developers
• errorCode: string
  The numerical code identifying the error
• message: string
  The localized message describing the error
• moreInfo: string
  An optional non-localized message with more information
• o:errorPath: string
  An optional machine readable description of where the error occurred
• status: string
  The HTTP status code

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top