Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Format improvements #415

Merged
merged 4 commits into from
Sep 7, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 30 additions & 30 deletions src/pages/guides/endpoints/classifications/import-file.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,25 +37,25 @@ curl -X POST "https://analytics.adobe.io/api/{GLOBALCOMPANYID}/classification/jo
-H "Content-Type: application/json" \
-H "Authorization: Bearer {ACCESS_TOKEN}" \
-d '{
"dataFormat": "tsv",
"encoding": "UTF8",
"jobName": "testsuite evar1 classifications",
"notifications": [
{
"method": "email",
"state": "completed",
"recipients": [
[email protected]
]
}
],
"listDelimiter": ",",
"source": "Direct API Upload",
"keyOptions": {
"byte_length": 0,
"type": "string"
"dataFormat": "tsv",
"encoding": "UTF8",
"jobName": "testsuite evar1 classifications",
"notifications": [
{
"method": "email",
"state": "completed",
"recipients": [
"[email protected]"
]
Copy link
Collaborator

@johnwight johnwight Sep 6, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The orphan single quote indeed suggests a JSON error. This is a direct value taken from Tony so I will double-check with him after merge to verify.

}
}'
],
"listDelimiter": ",",
"source": "Direct API Upload",
"keyOptions": {
"byte_length": 0,
"type": "string"
}
}'
```

#### Response
Expand Down Expand Up @@ -104,17 +104,17 @@ curl -X POST "https://analytics.adobe.io/api/{GLOBALCOMPANYID}/classification/jo

The example request above creates an import job with the following specifications:

* the `dataFormat` for the classification as `tsv`.
* the `jobName` to be `testsuite evar1 classifications`.
* the notification will be delivered by `email` to `[email protected]` when the state is `completed`.
* the data source is `Direct API Upload`.
* The `dataFormat` for the classification as `tsv`.
* The `jobName` to be `testsuite evar1 classifications`.
* The notification will be delivered by `email` to `[email protected]` when the state is `completed`.
* The data source is `Direct API Upload`.

### Response example details

The example response above shows the following job creation information:

* the `api_job_id` is `a6fc824c-4d6f-45f9-8f55-456f918e0b41`. This ID is necessary to both upload and commit the dataset with the other endpoints in this guide.
* the notification details, including its `completed` state.
* The `api_job_id` is `a6fc824c-4d6f-45f9-8f55-456f918e0b41`. This ID is necessary to both upload and commit the dataset with the other endpoints in this guide.
* The notification details, including its `completed` state.

### Request Parameters

Expand Down Expand Up @@ -198,26 +198,26 @@ curl -X PUT "https://analytics.adobe.io.api/{GLOBAL_COMPANY_ID}/classification/j
-H "Authorization: Bearer {ACCESS_TOKEN}" \
-H "Content-Type: multipart/form-data" \
-d '{
"Key": "example_file.tsv",
"Value": "/files/examples/example_file.tsv"
"Key": "example_file.tsv",
"Value": "/files/examples/example_file.tsv"
}'
```

#### Response

```json
{
"api_job_id": "a6fc824c-4d6f-45f9-8f55-456f918e0b41",
"status": "success"
"api_job_id": "a6fc824c-4d6f-45f9-8f55-456f918e0b41",
"status": "success"
}
```

### Request example details

The example above shows a cURL request with the following:

* the `Key` parameter specified as the file name `example_file.tsv`.
* the `Value` parameter specified as the file path `/files/examples/example_file.tsv`.
* The `Key` parameter specified as the file name `example_file.tsv`.
* The `Value` parameter specified as the file path `/files/examples/example_file.tsv`.

### Response example details

Expand Down
Loading