IVSWikiBlue: Created page with "This API call will update the metadata on other information associated with a specified recording. ===Resource URL===

http://valt.example.com/api/v3/records/{recordingid..."

2020-04-14T20:00:36Z

Created page with "This API call will update the metadata on other information associated with a specified recording. ===Resource URL=== <pre>http://valt.example.com/api/v3/records/{recordingid..."

New page

This API call will update the metadata on other information associated with a specified recording.

===Resource URL===
<pre>http://valt.example.com/api/v3/records/{recordingid}/update?</pre>
''Replace {recordingid} with the actual id number of the recording. Recordingss are numbered sequentially when added to VALT.''

===Resource Information===
{|class="wikitable"
|'''Method'''
|POST
|-
|'''Headers'''
|Content-Type:application/json
|-
|'''Response Type'''
|JSON
|-
|'''Authentication Required'''
|Yes
|}

===Parameters===
The JSON body must be properly formatted. All fields and values should be enclosed in double quotes and separated by a colon.
{|class="wikitable"
!colspan="3"|Field Name
!Description
!Required
!Example
|-
|colspan="3"|'''name'''
|Recording Name
|no
|Session 1451
|-
|colspan="3"|'''template'''
|JSON object containing field information for the default template of the recording author. This is required if there are any required fields in the template.
|no
|{"1":"1234567890","3":"John Doe","4":"Adult","5":"Suspect","6":"John Smith"}
|-
|
|colspan="2"|'''{fieldid}'''
|Value to populate in the specified field ID. Replace {fieldid} with the id number for the field that you wish to populate. Template field IDs can be retrieved by [[API Template Details|listing the details for a specified template.]]
|no
|Behavioral Anaylsis

|-
|colspan="3"|'''share'''
|Specify users and/or groups the video will be shared with. This is in addition to any default rights.
|no
|{"users":[13,54,23],"groups":[2,5,13]}
|-
|
|colspan="2"|'''users'''
|Array of user IDs the video will be shared with.
|no
|[13,54,23]
|-
|
|colspan="2"|'''groups'''
|Array of group IDs the video will be shared with.
|no
|[2,5,13]
|-
|colspan="3"|'''retention'''
|
|no
|{"type":"for","for":{"days":30}}
|-
|-
|
|colspan="2"|'''type'''
|Retention Type (Valid Values: inherit,infinitely,until,for)
|no
|until
|-
|
|colspan="2"|'''until'''
|Date videos will be retained until.
|no
|06-01-2020
|-
|
|colspan="2"|'''for'''
|Number of hours, days, or minutes videos will be retained for.
|no
|"for":{"days":30}
|-
|
|
|'''days'''
|Number of days to retain video. (Should only be specified if type is set to '''for'''.)
|no
|30
|-
|
|
|'''hours'''
|Number of hours to retain video. (Should only be specified if type is set to '''for'''.)
|no
|24
|-
|
|
|'''minutes'''
|Number of minutes to retain video. (Should only be specified if type is set to '''for'''.)
|no
|180
|-
|}

===Response===

{|class="wikitable"
!Code
!Reason
|-
|200
|Recording Started Successfully
|-
|400
|Invalid Request (See Response for Specific Error)
|-
|401
|Unauthorized
|-
|404
|Recording ID Not Found
|-
|500
|JSON Body Formatted Incorrectly
|}

{|class="wikitable"
|+JSON Response
!colspan="2"|data
|-
|'''id'''
|ID number for the updated recording.
|}

==Examples==
===Request===
The sample JSON body below is formatted with line breaks and indentation to make it easier to read. This is '''not''' required.
<pre>https://ivstest1.ad.ipivs.com/api/v3/records/616/update?access_token=e82632d19c523678fea3d1016c6df9e9</pre>
<nowiki>
{
"name":"API Update",
"retention": {
"type":"for",
"for":
{
"days":30
}
}
}
</nowiki>

===Successful Response===
Sample response is shown with line breaks to make it more readable. Actual responses will not include line breaks.
<nowiki>
{
"data":{
"id": 616
}
}
</nowiki>

===Failure Response===
Sample response is shown with line breaks to make it more readable. Actual responses will not include line breaks.
<nowiki>
{
"error":{
"code": 404
}
}
</nowiki>

API Change Recording - Revision history

IVSWikiBlue: Created page with "This API call will update the metadata on other information associated with a specified recording. ===Resource URL===
http://valt.example.com/api/v3/records/{recordingid..."