Jump to

• Request
• Response

Batch Create Baseline Categories

post

/api/restapi/baselineCategory/batch

Send a request to this endpoint to create one or more baseline categories. An application object will be created for each JSON object provided in the request body.

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

Supported Media Types

• application/json

201 Response

The object was successfully created.

Body ()

Root Schema : List<ApiEntityBaselineCategory>

Type: array

Title: List<ApiEntityBaselineCategory>

Show Source

• Array of: object ApiEntityBaselineCategory
  Title: ApiEntityBaselineCategory

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

Nested Schema : ApiEntityBaselineCategory

Type: object

Title: ApiEntityBaselineCategory

Show Source

• associationType: string
  Allowed Values: [ "OWNED", "INHERITED" ]

  The type of association in the relationship between the baseline category and the workspace.
• baselineCategoryId: integer (int64)
  The system-generated unique identifier of a baseline category.
• baselineCategoryName: string
  Minimum Length: 1

  Maximum Length: 255

  The name of the baseline category.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• 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.
• updateDate: string (date-time)
  Date when the record was last updated.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

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

{
    "title":"ApiEntityBaselineCategory",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "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"
            ]
        },
        "associationType":{
            "type":"string",
            "description":"The type of association in the relationship between the baseline category and the workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "OWNED",
                "INHERITED"
            ]
        }
    },
    "exampleSetFlag":false
}

400 Response

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

Back to Top