Create Alias in a Stage
  • 08 Nov 2022
  • 1 Minute to read
  • Contributors
  • Dark
    Light
  • PDF

Create Alias in a Stage

  • Dark
    Light
  • PDF

Create new Alias

Method for creating a new Alias in a Stage.

postman Download our collection of Postman queries to see more examples of Corezoid API v2.

URL

https://api.corezoid.com/api/2/json/{{API_LOGIN}}/{{TIMESTAMP}}/{{SIGNATURE}}

Request Body

{
    "ops": [
        {
            "type": "create",
            "obj": "alias",
            "title": {{ALIAS_NAME}},
            "description": {{ALIAS_DESCRIPTION}},
            "short_name": {{ALIAS_SHORT_NAME}},
            "project_id": {{PROJECT_ID}},
            "stage_id": {{STAGE_ID}},
            "company_id": {{COMPANY_ID}}
        }
    ]
}
Parameter Type Required Description Possible value
ops JSON Object + The list of operations to proceed via Corezoid API. A parameter keeping JSON objects with operations * The number is user-limited by RPS limit.
type string + A request type create
obj string + An object of request alias
title string + Created Alias name Any valid string
description string - Created Alias description Any valid string
short_name string + A short name of the created Alias that will be associated with a linked object At least three symbols. Allowed letters (Aa-Zz), numbers (0-9), and dashes (-)
project_id number + ID of the Project, in which the Alias will be created. You can use project_short_name instead ID of an existing Project
project_short_name string +* Short name of the Project, in which the Alias will be created, optional. *You can use it instead of the project_id Short name of an existing Project
stage_id number + ID of the Stage, in which the Alias will be created. You can use stage_short_name instead ID of an existing Stage
stage_short_name string +* Short name of the Stage, in which the Alias will be created, optional. *You can use it instead of the stage_id ID of an existing Stage
company_id string + An ID of a Company, in which the Alias will be created An ID of an existing Company

Response Body

{
    "request_proc": "ok",
    "ops": [
        {
            "id": "",
            "obj_id": 78,
            "proc": "ok",
            "obj": "alias"
        }
    ]
}
Parameter Type Description Possible value
request_proc string Overall processing status of all transactions from the request ok, error
ops array The list of request results
id string Request id empty
obj_id number An ID of created Alias
proc string Processing status of a specific operation ok, error
obj string An object of request alias