JobCommentsApi.md

\JobCommentsApi

All URIs are relative to https://api.phrase.com/v2

Method	HTTP request	Description
JobCommentCreate	Post /projects/{project_id}/jobs/{job_id}/comments	Create a job comment
JobCommentDelete	Delete /projects/{project_id}/jobs/{job_id}/comments/{id}	Delete a job comment
JobCommentShow	Get /projects/{project_id}/jobs/{job_id}/comments/{id}	Get a single job comment
JobCommentUpdate	Patch /projects/{project_id}/jobs/{job_id}/comments/{id}	Update a job comment
JobCommentsList	Get /projects/{project_id}/jobs/{job_id}/comments	List job comments

JobCommentCreate

JobComment JobCommentCreate(ctx, projectId, jobId, jobCommentCreateParameters, optional)

Create a job comment

Create a new comment for a job.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
projectId	string	Project ID
jobId	string	Job ID
jobCommentCreateParameters	JobCommentCreateParameters
optional	*JobCommentCreateOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a JobCommentCreateOpts struct

Name	Type	Description	Notes

xPhraseAppOTP | optional.String| Two-Factor-Authentication token (optional) |

Return type

JobComment

Authorization

Basic, Token

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

JobCommentDelete

JobCommentDelete(ctx, projectId, jobId, id, optional)

Delete a job comment

Delete an existing job comment.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
projectId	string	Project ID
jobId	string	Job ID
id	string	ID
optional	*JobCommentDeleteOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a JobCommentDeleteOpts struct

Name	Type	Description	Notes

xPhraseAppOTP | optional.String| Two-Factor-Authentication token (optional) | branch | optional.String| specify the branch to use |

Return type

(empty response body)

Authorization

Basic, Token

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

JobCommentShow

JobComment JobCommentShow(ctx, projectId, jobId, id, optional)

Get a single job comment

Get details on a single job comment.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
projectId	string	Project ID
jobId	string	Job ID
id	string	ID
optional	*JobCommentShowOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a JobCommentShowOpts struct

Name	Type	Description	Notes

xPhraseAppOTP | optional.String| Two-Factor-Authentication token (optional) | branch | optional.String| specify the branch to use |

Return type

JobComment

Authorization

Basic, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

JobCommentUpdate

JobComment JobCommentUpdate(ctx, projectId, keyId, id, jobCommentUpdateParameters, optional)

Update a job comment

Update an existing job comment.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
projectId	string	Project ID
keyId	string	Translation Key ID
id	string	ID
jobCommentUpdateParameters	JobCommentUpdateParameters
optional	*JobCommentUpdateOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a JobCommentUpdateOpts struct

Name	Type	Description	Notes

xPhraseAppOTP | optional.String| Two-Factor-Authentication token (optional) |

Return type

JobComment

Authorization

Basic, Token

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

JobCommentsList

[]JobComment JobCommentsList(ctx, projectId, jobId, optional)

List job comments

List all comments for a job.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
projectId	string	Project ID
jobId	string	Job ID
optional	*JobCommentsListOpts	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a JobCommentsListOpts struct

Name	Type	Description	Notes

xPhraseAppOTP | optional.String| Two-Factor-Authentication token (optional) | branch | optional.String| specify the branch to use | order | optional.String| Order direction. Can be one of: asc, desc. |

Return type

[]JobComment

Authorization

Basic, Token

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]