Jump to

• Request
• Response
• Examples

Export Source

post

/serviceapi/logan.content/export

Export source/parser/field info to zip file.

Request

Supported Media Types

• multipart/form-data

Form Parameters

• FIELD_DNAME(optional): string
  FieldDname list of fields to be exported
• PARSER_DNAME(optional): string
  ParserDname list of parsers to be exported
• PARSER_ID(optional): string
  ParserId list of parsers to be exported.
• SOURCE_DNAME(optional): string
  SourceDname list of sources to be exported
• SOURCE_ID(optional): string
  SourceId list of sources to be exported.

Back to Top

Response

Supported Media Types

• application/zip

200 Response

Operation succeeded.

400 Response

Bad request. See response body for explanation.

Body ()

Root Schema : InternalErrorResponse

Type: object

Show Source

• messages(optional): array messages
• type(optional): string
  Allowed Values: [ "PARSERERROR", "INVALIDPARAMETER", "UNSUPPORTEDSUBSYSTEM", "UNSUPPORTEDFILTER", "UNSUPPORTEDVERSION", "INVALIDJOBID", "INVALIDQUERYID", "FORBIDDEN", "INTERNALERROR", "JSONERROR", "INTERRUPTEDERROR", "EXECUTIONERROR", "COMPILATIONERROR", "SERVICEAVAILABILITYERROR" ]
• violations(optional): array violations

{
    "properties":{
        "messages":{
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "type":{
            "enum":[
                "PARSERERROR",
                "INVALIDPARAMETER",
                "UNSUPPORTEDSUBSYSTEM",
                "UNSUPPORTEDFILTER",
                "UNSUPPORTEDVERSION",
                "INVALIDJOBID",
                "INVALIDQUERYID",
                "FORBIDDEN",
                "INTERNALERROR",
                "JSONERROR",
                "INTERRUPTEDERROR",
                "EXECUTIONERROR",
                "COMPILATIONERROR",
                "SERVICEAVAILABILITYERROR"
            ],
            "type":"string"
        },
        "violations":{
            "items":{
                "$ref":"#/definitions/ParserViolation"
            },
            "type":"array"
        }
    },
    "type":"object"
}

Nested Schema : messages

Type: array

Show Source

• Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array"
}

Nested Schema : violations

Type: array

Show Source

• Array of: object ParserViolation

{
    "items":{
        "$ref":"#/definitions/ParserViolation"
    },
    "type":"array"
}

Nested Schema : ParserViolation

Type: object

Show Source

• end(optional): integer(int32)
• message(optional): string
• start(optional): integer(int32)

{
    "properties":{
        "end":{
            "format":"int32",
            "type":"integer"
        },
        "message":{
            "type":"string"
        },
        "start":{
            "format":"int32",
            "type":"integer"
        }
    },
    "type":"object"
}

403 Response

Forbidden. User does not have required privileges.

500 Response

Internal server error. See response body for explanation.

Body ()

Root Schema : InternalErrorResponse

Type: object

Show Source

• messages(optional): array messages
• type(optional): string
  Allowed Values: [ "PARSERERROR", "INVALIDPARAMETER", "UNSUPPORTEDSUBSYSTEM", "UNSUPPORTEDFILTER", "UNSUPPORTEDVERSION", "INVALIDJOBID", "INVALIDQUERYID", "FORBIDDEN", "INTERNALERROR", "JSONERROR", "INTERRUPTEDERROR", "EXECUTIONERROR", "COMPILATIONERROR", "SERVICEAVAILABILITYERROR" ]
• violations(optional): array violations

{
    "properties":{
        "messages":{
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "type":{
            "enum":[
                "PARSERERROR",
                "INVALIDPARAMETER",
                "UNSUPPORTEDSUBSYSTEM",
                "UNSUPPORTEDFILTER",
                "UNSUPPORTEDVERSION",
                "INVALIDJOBID",
                "INVALIDQUERYID",
                "FORBIDDEN",
                "INTERNALERROR",
                "JSONERROR",
                "INTERRUPTEDERROR",
                "EXECUTIONERROR",
                "COMPILATIONERROR",
                "SERVICEAVAILABILITYERROR"
            ],
            "type":"string"
        },
        "violations":{
            "items":{
                "$ref":"#/definitions/ParserViolation"
            },
            "type":"array"
        }
    },
    "type":"object"
}

Nested Schema : messages

Type: array

Show Source

• Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array"
}

Nested Schema : violations

Type: array

Show Source

• Array of: object ParserViolation

{
    "items":{
        "$ref":"#/definitions/ParserViolation"
    },
    "type":"array"
}

Nested Schema : ParserViolation

Type: object

Show Source

• end(optional): integer(int32)
• message(optional): string
• start(optional): integer(int32)

{
    "properties":{
        "end":{
            "format":"int32",
            "type":"integer"
        },
        "message":{
            "type":"string"
        },
        "start":{
            "format":"int32",
            "type":"integer"
        }
    },
    "type":"object"
}

Back to Top

Examples

The following example shows how to export multiple sources using their DNAME into a ZIP file called response.zip by submitting a POST request on the REST resource using cURL

curl -u "OMC_USERNAME" -X POST -H "Content-Type: application/x-www-form-urlencoded" "https://{OMC_URL}/serviceapi/logan.content/export" -d 'sourceDname=mgSrc' -d 'sourceDname=mgSrc2' -o response.zip

Example of Response

The following shows an example of the response body.

  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current   Dload  Upload   Total   Spent    Left  Speed
  0     0    0     0    0    36      0     30 --:--:--  0:00:01 --:--:--     0< HTTP/1.1 200 OK

Back to Top