Propiedades personalizadas - GitHub Enterprise Server 3.18 Docs

Get custom properties for an enterprise

Gets all custom properties defined for an enterprise. Enterprise members can read these properties.

Tokens de acceso específicos para "Get custom properties for an enterprise"

Este punto de conexión funciona con los siguientes tipos de token pormenorizados:

El token pormenorizado debe tener el siguiente conjunto de permisos:

"Custom properties" enterprise permissions (read)

Parámetros para "Get custom properties for an enterprise"

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
`enterprise` string Requerido The slug version of the enterprise name.

Códigos de estado de respuesta HTTP para "Get custom properties for an enterprise"

status code	Descripción
`200`	OK
`403`	Forbidden
`404`	Resource not found

Ejemplos de código para "Get custom properties for an enterprise"

Ejemplo de solicitud

get/enterprises/{enterprise}/properties/schema

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/enterprises/ENTERPRISE/properties/schema

Response

Status: 200

[
  {
    "property_name": "environment",
    "url": "https://HOSTNAME/orgs/github/properties/schema/environment",
    "source_type": "organization",
    "value_type": "single_select",
    "required": true,
    "default_value": "production",
    "description": "Prod or dev environment",
    "allowed_values": [
      "production",
      "development"
    ],
    "values_editable_by": "org_actors"
  },
  {
    "property_name": "service",
    "url": "https://HOSTNAME/orgs/github/properties/schema/service",
    "source_type": "organization",
    "value_type": "string"
  },
  {
    "property_name": "team",
    "url": "https://HOSTNAME/orgs/github/properties/schema/team",
    "source_type": "organization",
    "value_type": "string",
    "description": "Team owning the repository"
  }
]

Create or update custom properties for an enterprise

Creates new or updates existing custom properties defined for an enterprise in a batch.

If the property already exists, the existing property will be replaced with the new values. Missing optional values will fall back to default values, previous values will be overwritten. E.g. if a property exists with values_editable_by: org_and_repo_actors and it's updated without specifying values_editable_by, it will be updated to default value org_actors.

To use this endpoint, the authenticated user must be an administrator for the enterprise.

Tokens de acceso específicos para "Create or update custom properties for an enterprise"

Este punto de conexión funciona con los siguientes tipos de token pormenorizados:

El token pormenorizado debe tener el siguiente conjunto de permisos:

"Custom properties" enterprise permissions (write)

Parámetros para "Create or update custom properties for an enterprise"

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
`enterprise` string Requerido The slug version of the enterprise name.

Nombre, Tipo, Descripción

properties array of objects Requerido

The array of custom properties to create or update.

Properties of properties

Nombre, Tipo, Descripción
`property_name` string Requerido The name of the property
`url` string The URL that can be used to fetch, update, or delete info about this property via the API.
`source_type` string The source type of the property Puede ser uno de los siguientes: `organization`, `enterprise`
`value_type` string Requerido The type of the value for the property Puede ser uno de los siguientes: `string`, `single_select`, `multi_select`, `true_false`
`required` boolean Whether the property is required.
`default_value` null or string or array Default value of the property
`description` string or null Short description of the property
`allowed_values` array of strings or null An ordered list of the allowed values of the property. The property can have up to 200 allowed values.
`values_editable_by` string or null Who can edit the values of the property Puede ser uno de los siguientes: `org_actors`, `org_and_repo_actors`, `null`

Códigos de estado de respuesta HTTP para "Create or update custom properties for an enterprise"

status code	Descripción
`200`	OK
`403`	Forbidden
`404`	Resource not found

Ejemplos de código para "Create or update custom properties for an enterprise"

Ejemplo de solicitud

patch/enterprises/{enterprise}/properties/schema

curl -L \
  -X PATCH \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/enterprises/ENTERPRISE/properties/schema \
  -d '{"properties":[{"property_name":"environment","value_type":"single_select","required":true,"default_value":"production","description":"Prod or dev environment","allowed_values":["production","development"],"values_editable_by":"org_actors"},{"property_name":"service","value_type":"string"},{"property_name":"team","value_type":"string","description":"Team owning the repository"}]}'

Response

Status: 200

[
  {
    "property_name": "environment",
    "url": "https://HOSTNAME/orgs/github/properties/schema/environment",
    "source_type": "organization",
    "value_type": "single_select",
    "required": true,
    "default_value": "production",
    "description": "Prod or dev environment",
    "allowed_values": [
      "production",
      "development"
    ],
    "values_editable_by": "org_actors"
  },
  {
    "property_name": "service",
    "url": "https://HOSTNAME/orgs/github/properties/schema/service",
    "source_type": "organization",
    "value_type": "string"
  },
  {
    "property_name": "team",
    "url": "https://HOSTNAME/orgs/github/properties/schema/team",
    "source_type": "organization",
    "value_type": "string",
    "description": "Team owning the repository"
  }
]

Promote a custom property to an enterprise

Promotes an existing organization custom property to an enterprise.

To use this endpoint, the authenticated user must be an administrator for the enterprise.

Tokens de acceso específicos para "Promote a custom property to an enterprise"

Este punto de conexión funciona con los siguientes tipos de token pormenorizados:

El token pormenorizado debe tener el siguiente conjunto de permisos:

"Custom properties" enterprise permissions (write)

Parámetros para "Promote a custom property to an enterprise"

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
`enterprise` string Requerido The slug version of the enterprise name.
`org` string Requerido The organization name. The name is not case sensitive.
`custom_property_name` string Requerido The custom property name

Códigos de estado de respuesta HTTP para "Promote a custom property to an enterprise"

status code	Descripción
`200`	OK
`403`	Forbidden
`404`	Resource not found

Ejemplos de código para "Promote a custom property to an enterprise"

Ejemplo de solicitud

put/enterprises/{enterprise}/properties/schema/organizations/{org}/{custom_property_name}/promote

curl -L \
  -X PUT \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/enterprises/ENTERPRISE/properties/schema/organizations/ORG/CUSTOM_PROPERTY_NAME/promote

Response

Status: 200

{
  "property_name": "environment",
  "url": "https://HOSTNAME/orgs/github/properties/schema/environment",
  "source_type": "organization",
  "value_type": "single_select",
  "required": true,
  "default_value": "production",
  "description": "Prod or dev environment",
  "allowed_values": [
    "production",
    "development"
  ]
}

Get a custom property for an enterprise

Gets a custom property that is defined for an enterprise. Enterprise members can read these properties.

Tokens de acceso específicos para "Get a custom property for an enterprise"

Este punto de conexión funciona con los siguientes tipos de token pormenorizados:

El token pormenorizado debe tener el siguiente conjunto de permisos:

"Custom properties" enterprise permissions (read)

Parámetros para "Get a custom property for an enterprise"

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
`enterprise` string Requerido The slug version of the enterprise name.
`custom_property_name` string Requerido The custom property name

Códigos de estado de respuesta HTTP para "Get a custom property for an enterprise"

status code	Descripción
`200`	OK
`403`	Forbidden
`404`	Resource not found

Ejemplos de código para "Get a custom property for an enterprise"

Ejemplo de solicitud

get/enterprises/{enterprise}/properties/schema/{custom_property_name}

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/enterprises/ENTERPRISE/properties/schema/CUSTOM_PROPERTY_NAME

Response

Status: 200

{
  "property_name": "environment",
  "url": "https://HOSTNAME/orgs/github/properties/schema/environment",
  "source_type": "organization",
  "value_type": "single_select",
  "required": true,
  "default_value": "production",
  "description": "Prod or dev environment",
  "allowed_values": [
    "production",
    "development"
  ]
}

Create or update a custom property for an enterprise

Creates a new or updates an existing custom property that is defined for an enterprise.

To use this endpoint, the authenticated user must be an administrator for the enterprise.

Tokens de acceso específicos para "Create or update a custom property for an enterprise"

Este punto de conexión funciona con los siguientes tipos de token pormenorizados:

El token pormenorizado debe tener el siguiente conjunto de permisos:

"Custom properties" enterprise permissions (write)

Parámetros para "Create or update a custom property for an enterprise"

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
`enterprise` string Requerido The slug version of the enterprise name.
`custom_property_name` string Requerido The custom property name

Parámetros del cuerpo
Nombre, Tipo, Descripción
`value_type` string Requerido The type of the value for the property Puede ser uno de los siguientes: `string`, `single_select`, `multi_select`, `true_false`
`required` boolean Whether the property is required.
`default_value` null or string or array Default value of the property
`description` string or null Short description of the property
`allowed_values` array of strings or null An ordered list of the allowed values of the property. The property can have up to 200 allowed values.
`values_editable_by` string or null Who can edit the values of the property Puede ser uno de los siguientes: `org_actors`, `org_and_repo_actors`, `null`

Códigos de estado de respuesta HTTP para "Create or update a custom property for an enterprise"

status code	Descripción
`200`	OK
`403`	Forbidden
`404`	Resource not found

Ejemplos de código para "Create or update a custom property for an enterprise"

Ejemplo de solicitud

put/enterprises/{enterprise}/properties/schema/{custom_property_name}

curl -L \
  -X PUT \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/enterprises/ENTERPRISE/properties/schema/CUSTOM_PROPERTY_NAME \
  -d '{"value_type":"single_select","required":true,"default_value":"production","description":"Prod or dev environment","allowed_values":["production","development"]}'

Response

Status: 200

{
  "property_name": "environment",
  "url": "https://HOSTNAME/orgs/github/properties/schema/environment",
  "source_type": "organization",
  "value_type": "single_select",
  "required": true,
  "default_value": "production",
  "description": "Prod or dev environment",
  "allowed_values": [
    "production",
    "development"
  ]
}

Remove a custom property for an enterprise

Remove a custom property that is defined for an enterprise.

To use this endpoint, the authenticated user must be an administrator for the enterprise.

Tokens de acceso específicos para "Remove a custom property for an enterprise"

Este punto de conexión funciona con los siguientes tipos de token pormenorizados:

El token pormenorizado debe tener el siguiente conjunto de permisos:

"Custom properties" enterprise permissions (write)

Parámetros para "Remove a custom property for an enterprise"

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de la ruta de acceso
Nombre, Tipo, Descripción
`enterprise` string Requerido The slug version of the enterprise name.
`custom_property_name` string Requerido The custom property name

Códigos de estado de respuesta HTTP para "Remove a custom property for an enterprise"

status code	Descripción
`204`	A header with no content is returned.
`403`	Forbidden
`404`	Resource not found

Ejemplos de código para "Remove a custom property for an enterprise"

Ejemplo de solicitud

delete/enterprises/{enterprise}/properties/schema/{custom_property_name}

curl -L \
  -X DELETE \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/enterprises/ENTERPRISE/properties/schema/CUSTOM_PROPERTY_NAME

A header with no content is returned.

Status: 204