2023:API Services (Service) - Revision history

Randallkinard at 18:03, 29 April 2024

2024-04-29T18:03:24Z

← Older revision		Revision as of 13:03, 29 April 2024
Line 1:		Line 1:
	{{AutoVersion}}		{{AutoVersion}}
	~~<section begin="glossary" />~~
	<blockquote>		<blockquote>{{#lst:Glossary\|API Services}}</blockquote>
	~~You can perform '''Batch''' processing via REST API web calls by installing '''''~~API Services~~'''''.~~
	</blockquote>
	~~<section end="glossary" />~~
	== About ==		== About ==

Dgreenwood: /* SetMetadata */

2024-04-19T21:44:21Z

SetMetadata

← Older revision		Revision as of 16:44, 19 April 2024
Line 1,535:		Line 1,535:
	</pre>		</pre>

	==== SetMetadata ====		==== SetMetadata: Edit a document's Data Field values ====

	<code>POST {baseUrl}/api/v1/BatchProcessing/Folders/{FolderId}/Metadata</code>		<code>POST {baseUrl}/api/v1/BatchProcessing/Folders/{FolderId}/Metadata</code>

Dgreenwood: /* SetMetadata */

2024-04-19T21:43:48Z

SetMetadata

← Older revision		Revision as of 16:43, 19 April 2024
Line 1,539:		Line 1,539:
	<code>POST {baseUrl}/api/v1/BatchProcessing/Folders/{FolderId}/Metadata</code>		<code>POST {baseUrl}/api/v1/BatchProcessing/Folders/{FolderId}/Metadata</code>

	This request will ~~edit~~ '''~~Data Field~~''' ~~values for an existing~~ '''~~Batch Folder~~'''. SetMetadata is similar to CreateFolder. The only difference is SetMetadata only edits '''Data Field''' values for an ''existing'' folder, where CreateFolder both creates the folder and ~~edits~~ its '''Data Fields'''.		This request will set a folder's '''Document Type''' and edit its '''Data Field''' values. SetMetadata is similar to CreateFolder. The only difference is SetMetadata only edits the folder's "metadata" ('''Document Type''' and '''Data Field''' values) for an ''existing'' folder, where CreateFolder both creates the folder and can edit its metadata.


			The SetMetadata endpoint has two required parameters.
			* Required Parameters:
			** <code>{FolderId}</code>: You ''must'' enter the '''Batch Folder's''' ID (GUID).
			*** This is the document whose data you want to edit.
			** "Metadata": Use this parameter to set the folder's '''Content Type''' (usually '''Document Type''') and enter values for single instance '''Data Fields'''.
			*** '''Content Type''' and '''Data Field''' values are edited with formatted JSON. See example below.
			<pre style="margin-left:60px">
			{
			"ContentTypeId": "00000000-0000-0000-0000-000000000000",
			"FieldValues": [
			{
			"Key": "Data_Field_1",
			"Value": "Value for Data Field 1"
			},
			{
			"Key": "DataField2",
			"Value": "Value for DataField2"
			}
			]
			}
			</pre>
			:::* Note: Spaces and special characters in '''Data Fields''' must be replaced by underscores in the "Key" names.
			:::* Note: "Key" names for '''Data Fields''' in single instance '''Data Sections''' must be entered using dot notation (e.g. "DataSectionName.DataFieldName")
			::* This information is passed in the API call's header.


			In this example, we assign an existing folder's '''Document Type''' and edit a single '''Data Field''' in its '''Data Model''' , using the following JSON.
			<pre>
			{
			"ContentTypeId": "57dd9e5b-1b56-4db7-8d47-dd641b33bd0b",
			"FieldValues": [
			{
			"Key": "Employee_ID",
			"Value": "KL51239"
			}
			]
			}
			</pre>

			[[File:2023 APIServices 03 01 19 SetMetadata-01.png\|class=simpleborder\|center]]


			[[File:2023 APIServices 03 01 16 CreateFolder-02.png\|class=simpleborder\|right]]


			The API assigned the document the "Info Sheet" '''Document Type''' and edited the "Employee ID" '''Data Field''' with the value we provided.


			When SetMetadata successfully alters a '''Batch Folder's''' metadata the server response is simply <code>true</code>
			<br clear=all>

Dgreenwood: /* CreateFolder: Create an empty Batch Folder (optionally with Data Field values) */

2024-04-19T21:32:39Z

CreateFolder: Create an empty Batch Folder (optionally with Data Field values)

← Older revision		Revision as of 16:32, 19 April 2024
Line 1,380:		Line 1,380:

	The CreateFolder endpoint has one required parameter and one optional parameter.		The CreateFolder endpoint has one required parameter and one optional parameter.
	* Required Parameters		* Required Parameters:
	** <code>{ParentId}</code>: You ''must'' enter the parent '''Batch Folder's''' ID (GUID).		** <code>{ParentId}</code>: You ''must'' enter the parent '''Batch Folder's''' ID (GUID).
	*** This is the folder in the '''Batch''' you want to put the document.		*** This is the folder in the '''Batch''' you want to put the document.
	*** When uploading to the root of a '''Batch''' this is ''not'' the '''Batch's''' ID. It is the '''Batch's''' root folder's ID.		*** When uploading to the root of a '''Batch''' this is ''not'' the '''Batch's''' ID. It is the '''Batch's''' root folder's ID.
	* Optional Parameters		* Optional Parameters:
	** "Metadata": You may optionally enter metadata for the '''Batch Folder''', setting the folder's '''Content Type''' (usually '''Document Type''') and enter values for single instance '''Data Fields'''.		** "Metadata": You may optionally enter metadata for the '''Batch Folder''', setting the folder's '''Content Type''' (usually '''Document Type''') and enter values for single instance '''Data Fields'''.
	*** '''Content Type''' and '''Data Field''' values are edited with formatted JSON. See example below.		*** '''Content Type''' and '''Data Field''' values are edited with formatted JSON. See example below.

Dgreenwood: /* CreateFolder: Create an empty Batch Folder (optionally with Data Field values) */

2024-04-19T21:32:30Z

CreateFolder: Create an empty Batch Folder (optionally with Data Field values)

← Older revision		Revision as of 16:32, 19 April 2024
Line 1,379:		Line 1,379:


	The CreateFolder endpoint has ~~three~~ required ~~parameters~~ and one optional parameter.		The CreateFolder endpoint has one required parameter and one optional parameter.
	* Required Parameters		* Required Parameters
	** <code>{ParentId}</code>: You ''must'' enter the parent '''Batch Folder's''' ID (GUID).		** <code>{ParentId}</code>: You ''must'' enter the parent '''Batch Folder's''' ID (GUID).

Dgreenwood: /* SetMetadata */

2024-04-19T21:32:03Z

SetMetadata

← Older revision		Revision as of 16:32, 19 April 2024
Line 1,536:		Line 1,536:

	==== SetMetadata ====		==== SetMetadata ====

			<code>POST {baseUrl}/api/v1/BatchProcessing/Folders/{FolderId}/Metadata</code>

			This request will edit '''Data Field''' values for an existing '''Batch Folder'''. SetMetadata is similar to CreateFolder. The only difference is SetMetadata only edits '''Data Field''' values for an ''existing'' folder, where CreateFolder both creates the folder and edits its '''Data Fields'''.

Dgreenwood: /* SetAttachment: Attach a file to a Batch Folder */

2024-04-19T21:25:45Z

SetAttachment: Attach a file to a Batch Folder

← Older revision		Revision as of 16:25, 19 April 2024
Line 1,530:		Line 1,530:

	Example response:		Example response:
	* A successful response is always the file's MIME type and file size		* A successful response is always the file's MIME type and file size.
	<pre>		<pre>
	Type: text/csv, Size: 4		Type: text/csv, Size: 4

Dgreenwood: /* SetAttachment: Attach a file to a Batch Folder */

2024-04-19T21:25:31Z

SetAttachment: Attach a file to a Batch Folder

← Older revision		Revision as of 16:25, 19 April 2024
Line 1,530:		Line 1,530:

	Example response:		Example response:
			* A successful response is always the file's MIME type and file size
	<pre>		<pre>
	Type: text/csv, Size: 4		Type: text/csv, Size: 4

Dgreenwood: /* SetAttachment: Attach a file to a Batch Folder */

2024-04-19T21:24:19Z

SetAttachment: Attach a file to a Batch Folder

← Older revision		Revision as of 16:24, 19 April 2024
Line 1,529:		Line 1,529:


			Example response:
	<pre>		<pre>
	Type: text/csv, Size: 4		Type: text/csv, Size: 4

Dgreenwood: /* SetAttachment: Attach a file to a Batch Folder */

2024-04-19T19:31:50Z

SetAttachment: Attach a file to a Batch Folder

← Older revision		Revision as of 14:31, 19 April 2024
Line 1,526:		Line 1,526:

	Success! The CSV file was attached to the '''Batch Folder''', now named "attached_file_0001.csv".		Success! The CSV file was attached to the '''Batch Folder''', now named "attached_file_0001.csv".
			<br clear=all>



			<pre>
			Type: text/csv, Size: 4
			</pre>

	==== SetMetadata ====		==== SetMetadata ====