Skip to content

Latest commit

 

History

History
564 lines (403 loc) · 16.8 KB

ReviewTypesApi.md

File metadata and controls

564 lines (403 loc) · 16.8 KB
Raw

Review Types Api

All URIs are relative to SUBMISSION_API_URL configuration variable.

Method HTTP request Description
searchReviewTypes GET /reviewTypes Search review types.
headReviewTypes HEAD /reviewTypes Same to search review types, but only response status and headers information return.
createReviewType POST /reviewTypes Create a review type.
getReviewType GET /reviewTypes/{reviewTypeId} Get the review type.
headReviewType HEAD /reviewTypes/{reviewTypeId} Same to get review type, but only response status and headers information return.
updateReviewType PUT /reviewTypes/{reviewTypeId} Fully update review type.
patchReviewType PATCH /reviewTypes/{reviewTypeId} Partially update review type.
deleteReviewType DELETE /reviewTypes/{reviewTypeId} Delete the review type.

searchReviewTypes

searchReviewTypes(reqQuery[, jwt])

Search review types. Link headers are sent back and they have rel set to prev, next, first, last and contain the relevant URL.

Example

const submissionApi = require('topcoder-submission-api-wrapper')
const submissionApiM2MClient = submissionApi(_.pick(config,
      ['AUTH0_URL', 'AUTH0_AUDIENCE', 'TOKEN_CACHE_TIME',
        'AUTH0_CLIENT_ID', 'AUTH0_CLIENT_SECRET', 'SUBMISSION_API_URL',
        'AUTH0_PROXY_SERVER_URL']))

const submissionApiUserCredentialsClient = submissionApi(_.pick(config,
      ['USERNAME', 'PASSWORD', 'TC_AUTHN_URL', 'TC_AUTHZ_URL', 'TC_CLIENT_ID',
       'TC_CLIENT_V2_CONNECTION', 'SUBMISSION_API_URL']))

const submissionApiJwtMethodArgClient = submissionApi(_.pick(config, 'SUBMISSION_API_URL'))

const reqQuery = {
  page: 1,
  perPage: 10,
  name: 'Review',
  isActive: true
}

// Promise model
submissionApiM2MClient
  .searchReviewTypes(reqQuery)
  .then(result => console.log(result.body, result.status))
  .catch(err => console.log(err))

submissionApiUserCredentialsClient
  .searchReviewTypes(reqQuery)
  .then(result => console.log(result.body, result.status))
  .catch(err => console.log(err))

submissionApiJwtMethodArgClient
  .searchReviewTypes(reqQuery, config.JWT)
  .then(result => console.log(result.body, result.status))
  .catch(err => console.log(err))

// Async / await model
await submissionApiM2MClient.searchReviewTypes(reqQuery)

await submissionApiUserCredentialsClient.searchReviewTypes(reqQuery)

await submissionApiJwtMethodArgClient.searchReviewTypes(reqQuery, config.JWT)

Parameters

Name Type Description
reqQuery Criteria the search criteria
jwt String the optional json web token

Return type

Array of ReviewType

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

headReviewTypes

headReviewTypes(reqQuery[, jwt])

Same to search review types, but only response status and headers information return.

Example

const submissionApi = require('topcoder-submission-api-wrapper')
const submissionApiM2MClient = submissionApi(_.pick(config,
      ['AUTH0_URL', 'AUTH0_AUDIENCE', 'TOKEN_CACHE_TIME',
        'AUTH0_CLIENT_ID', 'AUTH0_CLIENT_SECRET', 'SUBMISSION_API_URL',
        'AUTH0_PROXY_SERVER_URL']))

const submissionApiUserCredentialsClient = submissionApi(_.pick(config,
      ['USERNAME', 'PASSWORD', 'TC_AUTHN_URL', 'TC_AUTHZ_URL', 'TC_CLIENT_ID',
       'TC_CLIENT_V2_CONNECTION', 'SUBMISSION_API_URL']))

const submissionApiJwtMethodArgClient = submissionApi(_.pick(config, 'SUBMISSION_API_URL'))

const reqQuery = {
  page: 1,
  perPage: 10,
  name: 'Review',
  isActive: true
}

// Promise model
submissionApiM2MClient
  .headReviewTypes(reqQuery)
  .then(result => console.log(result.status))
  .catch(err => console.log(err))

submissionApiUserCredentialsClient
  .headReviewTypes(reqQuery)
  .then(result => console.log(result.status))
  .catch(err => console.log(err))

submissionApiJwtMethodArgClient
  .headReviewTypes(reqQuery, config.JWT)
  .then(result => console.log(result.status))
  .catch(err => console.log(err))

// Async / await model
await submissionApiM2MClient.headReviewTypes(reqQuery)

await submissionApiUserCredentialsClient.headReviewTypes(reqQuery)

await submissionApiJwtMethodArgClient.headReviewTypes(reqQuery, config.JWT)

Parameters

Name Type Description
reqQuery Criteria the search criteria
jwt String the optional json web token

Return type

null (empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

createReviewType

createReviewType(reqBody[, jwt])

Create a review type.

Example

const submissionApi = require('topcoder-submission-api-wrapper')
const submissionApiM2MClient = submissionApi(_.pick(config,
      ['AUTH0_URL', 'AUTH0_AUDIENCE', 'TOKEN_CACHE_TIME',
        'AUTH0_CLIENT_ID', 'AUTH0_CLIENT_SECRET', 'SUBMISSION_API_URL',
        'AUTH0_PROXY_SERVER_URL']))

const submissionApiUserCredentialsClient = submissionApi(_.pick(config,
      ['USERNAME', 'PASSWORD', 'TC_AUTHN_URL', 'TC_AUTHZ_URL', 'TC_CLIENT_ID',
       'TC_CLIENT_V2_CONNECTION', 'SUBMISSION_API_URL']))

const submissionApiJwtMethodArgClient = submissionApi(_.pick(config, 'SUBMISSION_API_URL'))

const reqBody = {
  name: 'Review',
  isActive: true
}

// Promise model
submissionApiM2MClient
  .createReviewType(reqBody)
  .then(result => console.log(result.body, result.status))
  .catch(err => console.log(err))

submissionApiUserCredentialsClient
  .createReviewType(reqBody)
  .then(result => console.log(result.body, result.status))
  .catch(err => console.log(err))

submissionApiJwtMethodArgClient
  .createReviewType(reqBody, config.JWT)
  .then(result => console.log(result.body, result.status))
  .catch(err => console.log(err))

// Async / await model
await submissionApiM2MClient.createReviewType(reqBody)

await submissionApiUserCredentialsClient.createReviewType(reqBody)

await submissionApiJwtMethodArgClient.createReviewType(reqBody, config.JWT)

Parameters

Name Type Description
reqBody ReviewTypeData the review type data
jwt String the optional json web token

Return type

ReviewType

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

getReviewType

getReviewType(reviewTypeId[, jwt])

Get the review type by id.

Example

const submissionApi = require('topcoder-submission-api-wrapper')
const submissionApiM2MClient = submissionApi(_.pick(config,
      ['AUTH0_URL', 'AUTH0_AUDIENCE', 'TOKEN_CACHE_TIME',
        'AUTH0_CLIENT_ID', 'AUTH0_CLIENT_SECRET', 'SUBMISSION_API_URL',
        'AUTH0_PROXY_SERVER_URL']))

const submissionApiUserCredentialsClient = submissionApi(_.pick(config,
      ['USERNAME', 'PASSWORD', 'TC_AUTHN_URL', 'TC_AUTHZ_URL', 'TC_CLIENT_ID',
       'TC_CLIENT_V2_CONNECTION', 'SUBMISSION_API_URL']))

const submissionApiJwtMethodArgClient = submissionApi(_.pick(config, 'SUBMISSION_API_URL'))

const reviewTypeId = '8f4e8b6a-0ad2-4ff6-ab19-afeb102ff3b4'

// Promise model
submissionApiM2MClient
  .getReviewType(reviewTypeId)
  .then(result => console.log(result.body, result.status))
  .catch(err => console.log(err))

submissionApiUserCredentialsClient
  .getReviewType(reviewTypeId)
  .then(result => console.log(result.body, result.status))
  .catch(err => console.log(err))

submissionApiJwtMethodArgClient
  .getReviewType(reviewTypeId, config.JWT)
  .then(result => console.log(result.body, result.status))
  .catch(err => console.log(err))

// Async / await model
await submissionApiM2MClient.getReviewType(reviewTypeId)

await submissionApiUserCredentialsClient.getReviewType(reviewTypeId)

await submissionApiJwtMethodArgClient.getReviewType(reviewTypeId, config.JWT)

Parameters

Name Type Description
reviewTypeId String the review type id
jwt String the optional json web token

Return type

ReviewType

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

headReviewType

headReviewType(reviewTypeId[, jwt])

Same to get review type, but only response status and headers information return.

Example

const submissionApi = require('topcoder-submission-api-wrapper')
const submissionApiM2MClient = submissionApi(_.pick(config,
      ['AUTH0_URL', 'AUTH0_AUDIENCE', 'TOKEN_CACHE_TIME',
        'AUTH0_CLIENT_ID', 'AUTH0_CLIENT_SECRET', 'SUBMISSION_API_URL',
        'AUTH0_PROXY_SERVER_URL']))

const submissionApiUserCredentialsClient = submissionApi(_.pick(config,
      ['USERNAME', 'PASSWORD', 'TC_AUTHN_URL', 'TC_AUTHZ_URL', 'TC_CLIENT_ID',
       'TC_CLIENT_V2_CONNECTION', 'SUBMISSION_API_URL']))

const submissionApiJwtMethodArgClient = submissionApi(_.pick(config, 'SUBMISSION_API_URL'))

const reviewTypeId = '8f4e8b6a-0ad2-4ff6-ab19-afeb102ff3b4'

// Promise model
submissionApiM2MClient
  .headReviewType(reviewTypeId)
  .then(result => console.log(result.status))
  .catch(err => console.log(err))

submissionApiUserCredentialsClient
  .headReviewType(reviewTypeId)
  .then(result => console.log(result.status))
  .catch(err => console.log(err))

submissionApiJwtMethodArgClient
  .headReviewType(reviewTypeId, config.JWT)
  .then(result => console.log(result.status))
  .catch(err => console.log(err))

// Async / await model
await submissionApiM2MClient.headReviewType(reviewTypeId)

await submissionApiUserCredentialsClient.headReviewType(reviewTypeId)

await submissionApiJwtMethodArgClient.headReviewType(reviewTypeId, config.JWT)

Parameters

Name Type Description
reviewTypeId String the review type id
jwt String the optional json web token

Return type

null (empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

updateReviewType

updateReviewType(reviewTypeId, reqBody[, jwt])

Fully update review type.

Example

const submissionApi = require('topcoder-submission-api-wrapper')
const submissionApiM2MClient = submissionApi(_.pick(config,
      ['AUTH0_URL', 'AUTH0_AUDIENCE', 'TOKEN_CACHE_TIME',
        'AUTH0_CLIENT_ID', 'AUTH0_CLIENT_SECRET', 'SUBMISSION_API_URL',
        'AUTH0_PROXY_SERVER_URL']))

const submissionApiUserCredentialsClient = submissionApi(_.pick(config,
      ['USERNAME', 'PASSWORD', 'TC_AUTHN_URL', 'TC_AUTHZ_URL', 'TC_CLIENT_ID',
       'TC_CLIENT_V2_CONNECTION', 'SUBMISSION_API_URL']))

const submissionApiJwtMethodArgClient = submissionApi(_.pick(config, 'SUBMISSION_API_URL'))

const reviewTypeId = '8f4e8b6a-0ad2-4ff6-ab19-afeb102ff3b4'
const reqBody = {
  name: 'Review',
  isActive: true
}

// Promise model
submissionApiM2MClient
  .updateReviewType(reviewTypeId, reqBody)
  .then(result => console.log(result.body, result.status))
  .catch(err => console.log(err))

submissionApiUserCredentialsClient
  .updateReviewType(reviewTypeId, reqBody)
  .then(result => console.log(result.body, result.status))
  .catch(err => console.log(err))

submissionApiJwtMethodArgClient
  .updateReviewType(reviewTypeId, reqBody, config.JWT)
  .then(result => console.log(result.body, result.status))
  .catch(err => console.log(err))

// Async / await model
await submissionApiM2MClient.updateReviewType(reviewTypeId, reqBody)

await submissionApiUserCredentialsClient.updateReviewType(reviewTypeId, reqBody)

await submissionApiJwtMethodArgClient.updateReviewType(reviewTypeId, reqBody, config.JWT)

Parameters

Name Type Description
reviewTypeId String the review type id
reqBody ReviewTypeData the review type data
jwt String the optional json web token

Return type

ReviewType

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

patchReviewType

patchReviewType(reviewTypeId, reqBody[, jwt])

Partially update review type.

Example

const submissionApi = require('topcoder-submission-api-wrapper')
const submissionApiM2MClient = submissionApi(_.pick(config,
      ['AUTH0_URL', 'AUTH0_AUDIENCE', 'TOKEN_CACHE_TIME',
        'AUTH0_CLIENT_ID', 'AUTH0_CLIENT_SECRET', 'SUBMISSION_API_URL',
        'AUTH0_PROXY_SERVER_URL']))

const submissionApiUserCredentialsClient = submissionApi(_.pick(config,
      ['USERNAME', 'PASSWORD', 'TC_AUTHN_URL', 'TC_AUTHZ_URL', 'TC_CLIENT_ID',
       'TC_CLIENT_V2_CONNECTION', 'SUBMISSION_API_URL']))

const submissionApiJwtMethodArgClient = submissionApi(_.pick(config, 'SUBMISSION_API_URL'))

const reviewTypeId = '8f4e8b6a-0ad2-4ff6-ab19-afeb102ff3b4'
const reqBody = {
  name: 'Review',
  isActive: true
}

// Promise model
submissionApiM2MClient
  .patchReviewType(reviewTypeId, reqBody)
  .then(result => console.log(result.body, result.status))
  .catch(err => console.log(err))

submissionApiUserCredentialsClient
  .patchReviewType(reviewTypeId, reqBody)
  .then(result => console.log(result.body, result.status))
  .catch(err => console.log(err))

submissionApiJwtMethodArgClient
  .patchReviewType(reviewTypeId, reqBody, config.JWT)
  .then(result => console.log(result.body, result.status))
  .catch(err => console.log(err))

// Async / await model
await submissionApiM2MClient.patchReviewType(reviewTypeId, reqBody)

await submissionApiUserCredentialsClient.patchReviewType(reviewTypeId, reqBody)

await submissionApiJwtMethodArgClient.patchReviewType(reviewTypeId, reqBody, config.JWT)

Parameters

Name Type Description
reviewTypeId String the review type id
reqBody ReviewTypeData the review type data
jwt String the optional json web token

Return type

ReviewType

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

deleteReviewType

deleteReviewType(reviewTypeId[, jwt])

Delete review type by id.

Example

const submissionApi = require('topcoder-submission-api-wrapper')
const submissionApiM2MClient = submissionApi(_.pick(config,
      ['AUTH0_URL', 'AUTH0_AUDIENCE', 'TOKEN_CACHE_TIME',
        'AUTH0_CLIENT_ID', 'AUTH0_CLIENT_SECRET', 'SUBMISSION_API_URL',
        'AUTH0_PROXY_SERVER_URL']))

const submissionApiUserCredentialsClient = submissionApi(_.pick(config,
      ['USERNAME', 'PASSWORD', 'TC_AUTHN_URL', 'TC_AUTHZ_URL', 'TC_CLIENT_ID',
       'TC_CLIENT_V2_CONNECTION', 'SUBMISSION_API_URL']))

const submissionApiJwtMethodArgClient = submissionApi(_.pick(config, 'SUBMISSION_API_URL'))

const reviewTypeId = '8f4e8b6a-0ad2-4ff6-ab19-afeb102ff3b4'

// Promise model
submissionApiM2MClient
  .deleteReviewType(reviewTypeId)
  .then(result => console.log(result.status))
  .catch(err => console.log(err))

submissionApiUserCredentialsClient
  .deleteReviewType(reviewTypeId)
  .then(result => console.log(result.status))
  .catch(err => console.log(err))

submissionApiJwtMethodArgClient
  .deleteReviewType(reviewTypeId, config.JWT)
  .then(result => console.log(result.status))
  .catch(err => console.log(err))

// Async / await model
await submissionApiM2MClient.deleteReviewType(reviewTypeId)

await submissionApiUserCredentialsClient.deleteReviewType(reviewTypeId)

await submissionApiJwtMethodArgClient.deleteReviewType(reviewTypeId, config.JWT)

Parameters

Name Type Description
reviewTypeId String the review type id
jwt String the optional json web token

Return type

null (empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json