Upsert a code component

PUT 
/v2/codecomponents

Upsert a code component

Request

• application/json-patch+json; x-api-version=2.0
• application/json; x-api-version=2.0
• text/json; x-api-version=2.0
• application/*+json; x-api-version=2.0
• application/xml; x-api-version=2.0
• text/xml; x-api-version=2.0
• application/*+xml; x-api-version=2.0

Body

The request to insert

id stringrequired

Possible values: non-empty

name stringrequired

Possible values: non-empty, Value must match regular expression [A-Za-z0-9\ \-]+

description stringnullable
version stringrequired

Possible values: non-empty

sasUri stringnullable
deprecated boolean
type stringrequired

Possible values: non-empty

componentOriginalFilename stringnullable
uploadedBy stringnullable
mappingDll byterequired

Body

The request to insert

id stringrequired

Possible values: non-empty

name stringrequired

Possible values: non-empty, Value must match regular expression [A-Za-z0-9\ \-]+

description stringnullable
version stringrequired

Possible values: non-empty

sasUri stringnullable
deprecated boolean
type stringrequired

Possible values: non-empty

componentOriginalFilename stringnullable
uploadedBy stringnullable
mappingDll byterequired

Body

The request to insert

id stringrequired

Possible values: non-empty

name stringrequired

Possible values: non-empty, Value must match regular expression [A-Za-z0-9\ \-]+

description stringnullable
version stringrequired

Possible values: non-empty

sasUri stringnullable
deprecated boolean
type stringrequired

Possible values: non-empty

componentOriginalFilename stringnullable
uploadedBy stringnullable
mappingDll byterequired

Body

The request to insert

id stringrequired

Possible values: non-empty

name stringrequired

Possible values: non-empty, Value must match regular expression [A-Za-z0-9\ \-]+

description stringnullable
version stringrequired

Possible values: non-empty

sasUri stringnullable
deprecated boolean
type stringrequired

Possible values: non-empty

componentOriginalFilename stringnullable
uploadedBy stringnullable
mappingDll byterequired

Body

The request to insert

id stringrequired

Possible values: non-empty

name stringrequired

Possible values: non-empty, Value must match regular expression [A-Za-z0-9\ \-]+

description stringnullable
version stringrequired

Possible values: non-empty

sasUri stringnullable
deprecated boolean
type stringrequired

Possible values: non-empty

componentOriginalFilename stringnullable
uploadedBy stringnullable
mappingDll byterequired

Body

The request to insert

id stringrequired

Possible values: non-empty

name stringrequired

Possible values: non-empty, Value must match regular expression [A-Za-z0-9\ \-]+

description stringnullable
version stringrequired

Possible values: non-empty

sasUri stringnullable
deprecated boolean
type stringrequired

Possible values: non-empty

componentOriginalFilename stringnullable
uploadedBy stringnullable
mappingDll byterequired

Body

The request to insert

id stringrequired

Possible values: non-empty

name stringrequired

Possible values: non-empty, Value must match regular expression [A-Za-z0-9\ \-]+

description stringnullable
version stringrequired

Possible values: non-empty

sasUri stringnullable
deprecated boolean
type stringrequired

Possible values: non-empty

componentOriginalFilename stringnullable
uploadedBy stringnullable
mappingDll byterequired

Responses

• 200
• 400
• 502

The code component corresponding to the ID

• text/plain; x-api-version=2.0
• application/json; x-api-version=2.0
• text/json; x-api-version=2.0
• application/xml; x-api-version=2.0
• text/xml; x-api-version=2.0

• Schema
• Example (from schema)

Schema

id stringrequired

Possible values: non-empty

uniqueId stringnullable
companyId stringnullable
name stringrequired

Possible values: non-empty, Value must match regular expression [A-Za-z0-9\ \-]+

description stringnullable
version stringrequired

Possible values: non-empty

sasUri stringnullable
deprecated boolean
type stringrequired

Possible values: non-empty

componentOriginalFilename stringnullable
uploadedBy stringnullable
lastUpdated date-timenullable
versionConverted int32

{
  "id": "string",
  "uniqueId": "string",
  "companyId": "string",
  "name": "string",
  "description": "string",
  "version": "string",
  "sasUri": "string",
  "deprecated": true,
  "type": "string",
  "componentOriginalFilename": "string",
  "uploadedBy": "string",
  "lastUpdated": "2024-09-27T08:40:18.660Z",
  "versionConverted": 0
}

• Schema
• Example (from schema)

Schema

id stringrequired

Possible values: non-empty

uniqueId stringnullable
companyId stringnullable
name stringrequired

Possible values: non-empty, Value must match regular expression [A-Za-z0-9\ \-]+

description stringnullable
version stringrequired

Possible values: non-empty

sasUri stringnullable
deprecated boolean
type stringrequired

Possible values: non-empty

componentOriginalFilename stringnullable
uploadedBy stringnullable
lastUpdated date-timenullable
versionConverted int32

{
  "id": "string",
  "uniqueId": "string",
  "companyId": "string",
  "name": "string",
  "description": "string",
  "version": "string",
  "sasUri": "string",
  "deprecated": true,
  "type": "string",
  "componentOriginalFilename": "string",
  "uploadedBy": "string",
  "lastUpdated": "2024-09-27T08:40:18.660Z",
  "versionConverted": 0
}

• Schema
• Example (from schema)

Schema

id stringrequired

Possible values: non-empty

uniqueId stringnullable
companyId stringnullable
name stringrequired

Possible values: non-empty, Value must match regular expression [A-Za-z0-9\ \-]+

description stringnullable
version stringrequired

Possible values: non-empty

sasUri stringnullable
deprecated boolean
type stringrequired

Possible values: non-empty

componentOriginalFilename stringnullable
uploadedBy stringnullable
lastUpdated date-timenullable
versionConverted int32

{
  "id": "string",
  "uniqueId": "string",
  "companyId": "string",
  "name": "string",
  "description": "string",
  "version": "string",
  "sasUri": "string",
  "deprecated": true,
  "type": "string",
  "componentOriginalFilename": "string",
  "uploadedBy": "string",
  "lastUpdated": "2024-09-27T08:40:18.661Z",
  "versionConverted": 0
}

• Schema
• Example (from schema)

Schema

id stringrequired

Possible values: non-empty

uniqueId stringnullable
companyId stringnullable
name stringrequired

Possible values: non-empty, Value must match regular expression [A-Za-z0-9\ \-]+

description stringnullable
version stringrequired

Possible values: non-empty

sasUri stringnullable
deprecated boolean
type stringrequired

Possible values: non-empty

componentOriginalFilename stringnullable
uploadedBy stringnullable
lastUpdated date-timenullable
versionConverted int32

{
  "id": "string",
  "uniqueId": "string",
  "companyId": "string",
  "name": "string",
  "description": "string",
  "version": "string",
  "sasUri": "string",
  "deprecated": true,
  "type": "string",
  "componentOriginalFilename": "string",
  "uploadedBy": "string",
  "lastUpdated": "2024-09-27T08:40:18.661Z",
  "versionConverted": 0
}

• Schema
• Example (from schema)

Schema

id stringrequired

Possible values: non-empty

uniqueId stringnullable
companyId stringnullable
name stringrequired

Possible values: non-empty, Value must match regular expression [A-Za-z0-9\ \-]+

description stringnullable
version stringrequired

Possible values: non-empty

sasUri stringnullable
deprecated boolean
type stringrequired

Possible values: non-empty

componentOriginalFilename stringnullable
uploadedBy stringnullable
lastUpdated date-timenullable
versionConverted int32

{
  "id": "string",
  "uniqueId": "string",
  "companyId": "string",
  "name": "string",
  "description": "string",
  "version": "string",
  "sasUri": "string",
  "deprecated": true,
  "type": "string",
  "componentOriginalFilename": "string",
  "uploadedBy": "string",
  "lastUpdated": "2024-09-27T08:40:18.661Z",
  "versionConverted": 0
}

Code component did not validate

Could not contact internal services. Please try again later or contact our support department

Loading...