Jump to

• Request
• Response
• Examples

List Editorial Role Referenced By Repositories

get

/content/management/api/v1.1/editorialRoles/{roleId}/referencedByRepositories

List repositories referenced by a custom editorial role.

Request

Path Parameters

• roleId: string
  id of the custom editorial role.

Query Parameters

• limit(optional): integer(int32)
  This parameter accepts a non negative integer and is used to control the size of the result.

  Default Value: 50
• links(optional): string
  This parameter accepts a comma-separated list of link names. By default, this parameter gives all the links applicable. Possible values are: self, canonical, describedby, first, last, prev, next
• offset(optional): integer(int32)
  This parameter accepts a non negative integer and is used to control the start index of the result.

  Default Value: 0
• totalResults(optional): boolean
  This parameter accepts a boolean flag. If specified as true, then the returned result must include the total result count.

  Default Value: false

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

Body ()

Root Schema : EditorialRoleReferencedByRepositories

Type: object

EditorialRoleReferencedByRepositories

Show Source

• aggregationResults(optional): array aggregationResults
  Aggregation results.
• count(optional): integer(int32)
  Total number of records in the current response.
• hasMore(optional): boolean
  Check whether there are more pages to fetch.
• items(optional): array items
  Singular resources contained in the collection.
• limit(optional): integer(int32)
  Actual page size used by the server. This might not be the same as what the client requests.
• links(optional): array links
  Links of the resource.
• offset(optional): integer(int32)
  The actual index from which the singular resources are returned.
• pinned(optional): array pinned
  Pinned items. Shows items pinned at the top of search list
• scrollId(optional): string
  scrollId if the search resolved to a scroll search.
• totalResults(optional): integer(int32)
  Total number of rows that satisfy the client request (excluding the paging parameters.)

{
    "type":"object",
    "properties":{
        "hasMore":{
            "type":"boolean",
            "description":"Check whether there are more pages to fetch."
        },
        "offset":{
            "type":"integer",
            "format":"int32",
            "description":"The actual index from which the singular resources are returned."
        },
        "count":{
            "type":"integer",
            "format":"int32",
            "description":"Total number of records in the current response."
        },
        "limit":{
            "type":"integer",
            "format":"int32",
            "description":"Actual page size used by the server. This might not be the same as what the client requests."
        },
        "totalResults":{
            "type":"integer",
            "format":"int32",
            "description":"Total number of rows that satisfy the client request (excluding the paging parameters.)"
        },
        "scrollId":{
            "type":"string",
            "description":"scrollId if the search resolved to a scroll search."
        },
        "items":{
            "type":"array",
            "description":"Singular resources contained in the collection.",
            "items":{
                "$ref":"#/definitions/RepositoryInEditorialRole"
            }
        },
        "aggregationResults":{
            "type":"array",
            "description":"Aggregation results.",
            "items":{
                "$ref":"#/definitions/AggregationResult"
            }
        },
        "links":{
            "type":"array",
            "description":"Links of the resource.",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "pinned":{
            "type":"array",
            "description":"Pinned items. Shows items pinned at the top of search list",
            "items":{
                "type":"string"
            }
        }
    },
    "description":"EditorialRoleReferencedByRepositories"
}

Nested Schema : aggregationResults

Type: array

Aggregation results.

Show Source

• Array of: object AggregationResult

{
    "type":"array",
    "description":"Aggregation results.",
    "items":{
        "$ref":"#/definitions/AggregationResult"
    }
}

Nested Schema : items

Type: array

Singular resources contained in the collection.

Show Source

• Array of: object RepositoryInEditorialRole
  Repository in Editorial Role Response

{
    "type":"array",
    "description":"Singular resources contained in the collection.",
    "items":{
        "$ref":"#/definitions/RepositoryInEditorialRole"
    }
}

Nested Schema : links

Type: array

Links of the resource.

Show Source

• Array of: object Link
  Link of the resource.

{
    "type":"array",
    "description":"Links of the resource.",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : pinned

Type: array

Pinned items. Shows items pinned at the top of search list

Show Source

• Array of: string

{
    "type":"array",
    "description":"Pinned items. Shows items pinned at the top of search list",
    "items":{
        "type":"string"
    }
}

Nested Schema : AggregationResult

Type: object

Show Source

• name(optional): string
  Read Only: true

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "readOnly":true
        }
    }
}

Nested Schema : RepositoryInEditorialRole

Type: object

Repository in Editorial Role Response

Show Source

• id(optional): string
  ID of a repository referenced by a custom editorial role.
• isUsed(optional): boolean
  Whether a custom editorial role is being used by a repository.
• links(optional): array links
  Links of a repository resource.
• name(optional): string
  Name of a repository referenced by a custom editorial role.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"ID of a repository referenced by a custom editorial role."
        },
        "name":{
            "type":"string",
            "description":"Name of a repository referenced by a custom editorial role."
        },
        "isUsed":{
            "type":"boolean",
            "description":"Whether a custom editorial role is being used by a repository."
        },
        "links":{
            "type":"array",
            "description":"Links of a repository resource.",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Repository in Editorial Role Response"
}

Nested Schema : links

Type: array

Links of a repository resource.

Show Source

• Array of: object Link
  Link of the resource.

{
    "type":"array",
    "description":"Links of a repository resource.",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : Link

Type: object

Link of the resource.

Show Source

• href(optional): string
  The target resource's URI. It could be template URI. It is a required property in the get response.
• mediaType(optional): string
  Media type.
• method(optional): string
  What HTTP method can be used to access the target resource.
• profile(optional): string
  Link to the metadata that describes the target resource.
• rel(optional): string
  Relation type. It is a required property in the get response.
• templated(optional): boolean
  Whether the URI is a template.

{
    "type":"object",
    "properties":{
        "href":{
            "type":"string",
            "description":"The target resource's URI. It could be template URI. It is a required property in the get response."
        },
        "rel":{
            "type":"string",
            "description":"Relation type. It is a required property in the get response."
        },
        "templated":{
            "type":"boolean",
            "description":"Whether the URI is a template."
        },
        "method":{
            "type":"string",
            "description":"What HTTP method can be used to access the target resource."
        },
        "profile":{
            "type":"string",
            "description":"Link to the metadata that describes the target resource."
        },
        "mediaType":{
            "type":"string",
            "description":"Media type."
        }
    },
    "description":"Link of the resource."
}

304 Response

Not modified.

400 Response

Bad request.

403 Response

Forbidden.

404 Response

Not found.

500 Response

Internal server error.

Back to Top

Examples

The following example shows how to list repositories referenced by a custom editorial role by submitting a GET request using cURL.

curl -X GET -H 'Accept: application/json' 'https://host:port/content/management/api/v1.1/editorialRoles/{roleId}/referencedByRepositories'

Example

/content/management/api/v1.1/editorialRoles/76F2903A0C8E48BCA222E68264BE1E05/referencedByRepositories?offset=0&limit=10&totalResults=true

This lists first set of 10 repositories referenced by a custom editorial roles with id 76F2903A0C8E48BCA222E68264BE1E05, sorted by repository name ascending. Here \"referenced by\" means the editorial role is assigned to those repositories.

Response Body

{
	    "hasMore": false,
	    "offset": 0,
	    "count": 2,
	    "limit": 2,
	    "totalResults": 2,
	    "items": [
	        {
	            "id": "48040240881C40749E10F57A060D8AB4",
	            "name": "Repo1",
	            "isUsed": false,
	            "links": [
	                {
	                    "href": "http://<hostname>/content/management/api/v1.1/repositories/48040240881C40749E10F57A060D8AB4",
	                    "rel": "self",
	                    "method": "GET",
	                    "mediaType": "application/json"
	                }
	            ]
	        },
	        {
	            "id": "7F289D0F4FD44C0382A83EFD44A355C0",
	            "name": "Repo2",
	            "isUsed": true,
	            "links": [
	                {
	                    "href": "http://<hostname>/content/management/api/v1.1/repositories/7F289D0F4FD44C0382A83EFD44A355C0",
	                    "rel": "self",
	                    "method": "GET",
	                    "mediaType": "application/json"
	                }
	            ]
	        }
	    ],
	    "links": [
	        {
	            "href": "http://<hostname>/content/management/api/v1.1/editorialRoles/76F2903A0C8E48BCA222E68264BE1E05/referencedByRepositories?limit=10&totalResults=true&offset=0",
	            "rel": "self",
	            "method": "GET",
	            "mediaType": "application/json"
	        },
	        {
	            "href": "http://<hostname>/content/management/api/v1.1/editorialRoles/76F2903A0C8E48BCA222E68264BE1E05/referencedByRepositories?limit=10&totalResults=true&offset=0",
	            "rel": "canonical",
	            "method": "GET",
	            "mediaType": "application/json"
	        },
	        {
	            "href": "http://<hostname>/content/management/api/v1.1/metadata-catalog/editorialRoles/76F2903A0C8E48BCA222E68264BE1E05/referencedByRepositories",
	            "rel": "describedby",
	            "method": "GET",
	            "mediaType": "application/json"
	        },
	        {
	            "href": "http://<hostname>/content/management/api/v1.1/editorialRoles/76F2903A0C8E48BCA222E68264BE1E05/referencedByRepositories?limit=10&totalResults=true&offset=0",
	            "rel": "first",
	            "method": "GET",
	            "mediaType": "application/json"
	        },
	        {
	            "href": "http://<hostname>/content/management/api/v1.1/editorialRoles/76F2903A0C8E48BCA222E68264BE1E05/referencedByRepositories?limit=10&totalResults=true&offset=0",
	            "rel": "last",
	            "method": "GET",
	            "mediaType": "application/json"
	        }
	    ]
      }

Back to Top