Come for the products,
stay for the community

The Atlassian Community can help you and your team get more value out of Atlassian products and practices.

Atlassian Community about banner
4,365,312
Community Members
 
Community Events
168
Community Groups

Difference between PUT and PATCH request for API /pages/{page_id}/incidents/{incident_id}

Is there any difference between PUT and PATCH requests for /pages/{page_id}/incidents/{incident_id} URL to update an incident? I see same result using any of the above,

1 answer

0 votes
DPK J Community Leader Apr 11, 2020

@Sandeep_A  Welcome to the community!

There is slight difference here (https://developer.statuspage.io/#section/Basics)

 

  • PATCH - Update a single element
  • PUT - Replace a single element in a collection (rarely used)

 

This means that when you call PATCH on `Incident`, only field that you are passing as payload will be updated and rest will remain same.

With PUT, all fields will be updated (i.e. old field will be replaced), it will require to send all fields as payload.

As an example, I am trying to update a particular component associated with an incident with PATCH request as below. As a result of this request, the other components associated with this incident are removed and only the one in the request is present. Ideally, the PATCH request should have just updated the component listed in this request and leave the rest as is. Any thoughts ?

{
"incident": {
"name": "Sample incident modified",
"status": "monitoring",
"impact_override": "minor",
"body": "We are continuing to work on a fix for this issue. Monitoring",
"components": {
"2vjjt397ssd2": "operational"
},
"component_ids": [
"2vjjt397ssd2"
]
}
}

DPK J Community Leader Apr 11, 2020

@Sandeep_ABy general API conventions your assumption is correct, but not all API providers are equal. So I guess for Atlassian in case of StatusPage, you need to provide full set for 'components_ids'.

But I will check with Atlassian team, if this is a design bug.

Like Sandeep_A likes this

Sure Thanks!. For now, there is no difference in the way PUT and PATCH behaves for this end-point.

Hello. I am on the exact same situation. When i try to add a new component in the components_id the previous values are replaced. 

So the only solution is to populate again the 2 arrays

components and

component_ids??

Suggest an answer

Log in or Sign up to answer
TAGS

Atlassian Community Events