opensoft/tfs-rest-api

An api wrapper for the TFS/VisualStudio REST API

Maintainers

Details

github.com/opensoft/tfs-rest-api

Source

Issues

Installs: 59

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 4

Forks: 0

Open Issues: 1

dev-master 2015-11-12 00:03 UTC

Requires

Requires (Dev)

MIT e40d97e1c546f9fe015952add75fd56128fb26d4

  • Richard Fullmer <richard.fullmer.woop@opensoftdev.com>

restapitfsvisual studiovso

This package is auto-updated.

Last update: 2024-11-27 06:46:03 UTC

README

A simple object oriented wrapper for the Visual Studio Online / Team Foundation Server REST API in PHP 5.5

Uses Guzzle 6 for REST requests.

Installation

Installable through composer via:

$ composer require opensoft/tfs-rest-api

Basic Usage

<?php

use Opensoft\Tfs\Rest\Client;

require_once __DIR__ . '/vendor/autoload.php';

$client = new Client(
    // your tfs/vso
    'https://opensoft.visualstudio.com',
    // your collection
    'AcmeApp',
    // (optional) raw options to pass to guzzle (ntlm example here)
    [                                      
        'curl' => [
            CURLOPT_HTTPAUTH => CURLAUTH_NTLM, 
            CURLOPT_USERPWD => 'username:password'
        ]
    ]
);

// retrieve a work item by its ID
$response = $client->workItemTracking()->getWorkItem(12345);

// get the result as an array
print_r($response->asArray());

// follow hypermedia links
$response = $response->follow('workItemHistory');

print_r($response->asArray());

Caution: There are many more APIs exposed by TFS/VSO than are implemented here. We've implemented only what we've needed internally for now, and will implement more as the need arises. Feel free to submit pull requests implementing more APIs and we'll be happy to merge them.

License

Licensed under the MIT License - see the LICENSE file for details