Jump to

• Request
• Response

Batch Update Baseline Categories

put

/api/restapi/baselineCategory/batch

Send a request to this endpoint to update one or more baseline categories. For each JSON object provided in the request body, an application object with a matching ID value will be updated to reflect the JSON contents.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : List<ApiEntityBaselineCategoryInput>

Type: array

Title: List<ApiEntityBaselineCategoryInput>

Show Source

• Array of: object ApiEntityBaselineCategoryInput
  Title: ApiEntityBaselineCategoryInput

  This entity represents a BaselineCategory object, a unique BaselineCategory object can be identified by the following combinations of the fields.

  • baselineCategoryId
  • baselineCategoryName,workspaceId
  • baselineCategoryName,workspaceCode

{
    "title":"List<ApiEntityBaselineCategoryInput>",
    "type":"array",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityBaselineCategoryInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityBaselineCategoryInput

Type: object

Title: ApiEntityBaselineCategoryInput

This entity represents a BaselineCategory object, a unique BaselineCategory object can be identified by the following combinations of the fields.

• baselineCategoryId
• baselineCategoryName,workspaceId
• baselineCategoryName,workspaceCode

Show Source

• baselineCategoryId: integer (int64)
  The system-generated unique identifier of a baseline category.
• baselineCategoryName(required): string
  Minimum Length: 1

  Maximum Length: 255

  The name of the baseline category.
• pushDownType: string
  Allowed Values: [ "MANUAL", "AUTOMATIC" ]

  How data is shared between parent and child workspaces.
  Manual: Data can be pulled down by child workspaces. This is the default option.
  Automatic: Data is automatically shared with all child workspaces.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of a workspace.
• workspaceId(required): integer (int64)
  The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.

{
    "title":"ApiEntityBaselineCategoryInput",
    "required":[
        "baselineCategoryName",
        "workspaceId"
    ],
    "type":"object",
    "properties":{
        "workspaceCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "baselineCategoryId":{
            "type":"integer",
            "description":"The system-generated unique identifier of a baseline category.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "baselineCategoryName":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"The name of the baseline category.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "pushDownType":{
            "type":"string",
            "description":"How data is shared between parent and child workspaces. <br />Manual: Data can be pulled down by child workspaces. This is the default option. <br />Automatic: Data is automatically shared with all child workspaces.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "MANUAL",
                "AUTOMATIC"
            ]
        }
    },
    "description":"This entity represents a BaselineCategory object, a unique BaselineCategory object can be identified by the following combinations of the fields.<ul><li>baselineCategoryId</li><li>baselineCategoryName,workspaceId</li><li>baselineCategoryName,workspaceCode</li>",
    "exampleSetFlag":false
}

Back to Top

Response

200 Response

A collection of object IDs mapped to a canonical link of the object. For example - {"links":{"1":"https://[host]:[port]/api/restapi/[object]/1","2":"https://[host]:[port]/api/restapi/[object]/2"}}

400 Response

Invalid input for the Baseline Category service. Verify the request contains valid data, then resubmit the request.

Back to Top