Eclipse Foundation Mailing List API (1.0.0)

Download OpenAPI specification:Download

License: Eclipse Public License - 2.0

Mailing Lists

Definitions in relation to retrieval of mailing lists

Mailing Lists

Returns a list of organizations from the Eclipse API

query Parameters

username

required

string

The user id

Responses

Response samples

200

Content type

application/json

[{"list_name": "string",
"list_description": null,
"email": "string",
"url": "string",
"project_id": "string",
"list_short_description": null,
"create_archives": true,
"is_for_news_archives": true,
"is_deleted": true,
"is_disabled": true,
"is_private": true,
"is_subscribable": true,
"create_date": "string",
"created_by": null,
"provision_status": null,
"count": null
}
]

Available Mailing Lists

Returns a list of mailing lists available for subscription

Responses

Response samples

200

Content type

application/json

[{"list_name": "string",
"list_description": null,
"email": "string",
"url": "string",
"project_id": "string",
"list_short_description": null,
"create_archives": true,
"is_for_news_archives": true,
"is_deleted": true,
"is_disabled": true,
"is_private": true,
"is_subscribable": true,
"create_date": "string",
"created_by": null,
"provision_status": null,
"count": null
}
]

Mailing List

Returns a list of organizations from the Eclipse API

path Parameters

listName

required

string

The name of the mailing list to retrieve

Responses

Response samples

200

Content type

application/json

[{"list_name": "string",
"list_description": null,
"email": "string",
"url": "string",
"project_id": "string",
"list_short_description": null,
"create_archives": true,
"is_for_news_archives": true,
"is_deleted": true,
"is_disabled": true,
"is_private": true,
"is_subscribable": true,
"create_date": "string",
"created_by": null,
"provision_status": null,
"count": null
}
]

Projects Mailing Lists

Returns a list of mailing lists mapped to project IDs

Responses

Response samples

200

Content type

application/json

{"property1": [{"list_name": "string",
"list_description": null,
"email": "string",
"url": "string",
"project_id": "string",
"list_short_description": null,
"create_archives": true,
"is_for_news_archives": true,
"is_deleted": true,
"is_disabled": true,
"is_private": true,
"is_subscribable": true,
"create_date": "string",
"created_by": null,
"provision_status": null,
"count": null
}
],
"property2": [{"list_name": "string",
"list_description": null,
"email": "string",
"url": "string",
"project_id": "string",
"list_short_description": null,
"create_archives": true,
"is_for_news_archives": true,
"is_deleted": true,
"is_disabled": true,
"is_private": true,
"is_subscribable": true,
"create_date": "string",
"created_by": null,
"provision_status": null,
"count": null
}
]
}

Available Projects Mailing Lists

Returns a list of mailing lists available for subscription mapped to project IDs

Responses

Response samples

200

Content type

application/json

{"property1": [{"list_name": "string",
"list_description": null,
"email": "string",
"url": "string",
"project_id": "string",
"list_short_description": null,
"create_archives": true,
"is_for_news_archives": true,
"is_deleted": true,
"is_disabled": true,
"is_private": true,
"is_subscribable": true,
"create_date": "string",
"created_by": null,
"provision_status": null,
"count": null
}
],
"property2": [{"list_name": "string",
"list_description": null,
"email": "string",
"url": "string",
"project_id": "string",
"list_short_description": null,
"create_archives": true,
"is_for_news_archives": true,
"is_deleted": true,
"is_disabled": true,
"is_private": true,
"is_subscribable": true,
"create_date": "string",
"created_by": null,
"provision_status": null,
"count": null
}
]
}

Project Mailing Lists

Returns a list of organizations from the Eclipse API

path Parameters

projectID

required

string

The ID of the project to retrieve mailing lists for

Responses

Response samples

200

Content type

application/json

[{"list_name": "string",
"list_description": null,
"email": "string",
"url": "string",
"project_id": "string",
"list_short_description": null,
"create_archives": true,
"is_for_news_archives": true,
"is_deleted": true,
"is_disabled": true,
"is_private": true,
"is_subscribable": true,
"create_date": "string",
"created_by": null,
"provision_status": null,
"count": null
}
]