Issues - lokenx/plex-requests GitHub Wiki

GET: /issues

Summary

Returns an array of issues reported for movies and TV shows.

Parameters

None

Returned JSON

{
    statusCode: 200,
    data: [
        {
            "title": "Sample Issue Title",
            "message": "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.",
            "user": "plexuser",
            "season": 1,
            "episode": 2,
            "created": "2016-01-07T01:06:03.860Z",
            "number": 23,
            "resolved": false,
            "_id": "V9hCBdxw0fTECjvx"
        }
    ]
    meta: {}
}

---

POST: /issues

Summary

Add a new issue to Plex Requests. Will return the saved object on success.

Parameters

Issue object should be provided in the body, JSON encoded.

{
    "title": "Sample Issue Title",
    "message": "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.",
    "user": "plexuser",
    "season": 1,
    "episode": 2,
    "created": "2016-01-07T01:06:03.860Z",
    "number": 23,
    "resolved": true,
}

Returned JSON

{
    "statusCode": 200,
    "data": {
        "title": "Sample Issue Title",
        "message": "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.",
        "user": "plexuser",
        "season": 1,
        "episode": 2,
        "created": "2016-01-07T01:06:03.860Z",
        "number": 23,
        "resolved": true,
    },
    "meta": {}
}

---

DELETE: /issues

Summary

Removes an issue from Plex Requests. This requires authenticating with an admin user JWT.

Parameters

Issue number should be provided in the body, JSON encoded.

{
    "number": 23,
    "title": "Sample Issue Title"
}

Returned JSON

{
    "statusCode": 200,
    "data": {
        "message": "Removed the movie Sample Issue Title"
    },
    "meta": {}
}  

---

PUT: /issues

Summary

Updates a single issue object. All fields can be updated. This requires authenticating with an admin user JWT.

Parameters

Movie object should be provided in the body, JSON encoded.

{
    "number": 23,
    "update": {
        "resolved": true
    }
}

Returned JSON

{
    "statusCode": 200,
    "data": {
        "title": "Sample Issue Title",
        "message": "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.",
        "user": "plexuser",
        "season": 1,
        "episode": 2,
        "created": "2016-01-07T01:06:03.860Z",
        "number": 23,
        "resolved": true,
    },
    "meta": {}
}